rnalysis.filtering.CountFilter.filter_by_row_name

CountFilter.filter_by_row_name(row_names: Union[str, List[str]], opposite: bool = False, inplace: bool = True)

Filter out specific rows from the table by their name (index).

Parameters

• row_names (str or list of str) – list of row names to be removed from the table.

• opposite (bool) – If True, the output of the filtering will be the OPPOSITE of the specified (instead of filtering out X, the function will filter out anything BUT X). If False (default), the function will filter as expected.

• inplace (bool (default=True)) – If True (default), filtering will be applied to the current Filter object. If False, the function will return a new Filter instance and the current instance will not be affected.

Returns

If inplace is False, returns a new and filtered instance of the Filter object.