Skip to content

Commit

Permalink
update docstrings for get_source_expression
Browse files Browse the repository at this point in the history
  • Loading branch information
balajtimate committed Oct 29, 2024
1 parent a536351 commit e5f2ea3
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions htsinfer/get_library_source.py
Original file line number Diff line number Diff line change
Expand Up @@ -247,17 +247,17 @@ def run_kallisto_quantification(
def get_source_expression(
kallisto_dir: Path,
) -> DataFrame:
"""Return percentages of total expression per read source.
"""Return percentages of total estimated counts per read source.
Args:
kallisto_dir: Directory containing Kallisto quantification results.
Returns:
Data frame with columns `source_ids` (a tuple of source short name
and taxon identifier, e.g., `("hsapiens", 9606)`) and
`est_counts`, signifying the percentages of total expression
per read source. The data frame is sorted by total expression
in descending order.
`est_counts`, signifying the percentages of total estimated
counts per read source. The data frame is sorted by total
estimated counts in descending order.
Raises:
FileProblem: Kallisto quantification results could not be
Expand Down Expand Up @@ -285,7 +285,7 @@ def get_source_expression(
# handle case where no alignments are found
dat.est_counts.fillna(0, inplace=True)

# aggregate expression by source identifiers
# aggregate counts by source identifiers
dat[[
'gene_symbol',
'gene_id',
Expand Down

0 comments on commit e5f2ea3

Please sign in to comment.