find_sub_tids_by_tid

DatabaseSILVA.find_sub_tids_by_tid(ids=None, ter_rank=None, flatten=False, mode='frame')

Get sub-tids by target tids as ids parameter.

Parameters
  • ids (Optional[Union[Sequence[Union[str, int]], numpy.ndarray, pandas.core.indexes.base.Index, str, int]]) – Target tids for which retrieve sub-tids

  • ter_rank (Optional[str]) – Terminal rank upto which retrieve sub-tids

  • 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 tids with type depending on input parameters.