take_tids_by_rank¶
- DatabaseGTDB.take_tids_by_rank(levels=None, iterator=False, flatten=False, mode='dict')¶
Get tids for given taxonomic ranks (level)
- Parameters
levels (Optional[Union[str, Sequence[str]]]) – Taxonomic ranks for which to retrieve tids.
iterator (bool) – Whether to data in chunks as iterator.
flatten (bool) – Whether to flatten tids for all ranks instead of returning Dict[rank, tids]
mode (str) – Retrieve data as ‘array’, ‘frame’ or ‘dict’(default)
- Returns
- Return type
Return tids with type depending on input parameters.