take_rids_by_rank

DatabaseGTDB.take_rids_by_rank(levels=None, iterator=False, flatten=False, mode='dict')

Get rids for given taxonomic ranks (level)

Parameters

• levels (Optional[Union[str, Sequence[str]]]) – Taxonomic ranks for which to retrieve rids.

• iterator (bool) – Whether to return data in chunks as iterator.

• flatten (bool) – Whether to flatten rids for all ranks instead of returning Dict[rank, rids]

• mode (str) – Retrieve data as ‘array’, ‘frame’ or ‘dict’(default)

Returns

Return type

Return rids with type depending on input parameters.