Documentation fixes

complextissue · May 30, 2024 · f704d14 · f704d14
1 parent cc0af42
commit f704d14
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/pytximport/core/_tximport.py b/pytximport/core/_tximport.py
@@ -49,8 +49,8 @@ def tximport(
     Args:
         file_paths (List[Union[str, Path]]): The paths to the quantification files.
         data_type (Literal["kallisto", "salmon"], optional): The type of quantification file.
-        transcript_gene_map (pd.DataFrame): The mapping from transcripts to genes. Contains two columns: `transcript`
-            and `gene`.
+        transcript_gene_map (pd.DataFrame): The mapping from transcripts to genes. Contains two columns: `transcript_id`
+            and `gene_id`.
         counts_from_abundance (Optional[Literal["scaled_tpm", "length_scaled_tpm"]], optional): The type of counts to
             convert to. Defaults to "length_scaled_tpm".
         return_transcript_data (bool, optional): Whether to return the transcript-level expression. Defaults to False.

diff --git a/pytximport/utils/_convert_transcripts_to_genes.py b/pytximport/utils/_convert_transcripts_to_genes.py
@@ -23,8 +23,8 @@ def convert_transcripts_to_genes(
 
     Args:
         transcript_data (xr.Dataset): The transcript-level expression data from multiple samples.
-        transcript_gene_map (pd.DataFrame): The mapping from transcripts to genes. Contains two columns: `transcript`
-            and `gene`.
+        transcript_gene_map (pd.DataFrame): The mapping from transcripts to genes. Contains two columns: `transcript_id`
+            and `gene_id`.
         ignore_after_bar (bool, optional): Whether to split the transcript id after the bar character (`|`).
             Defaults to True.
         ignore_transcript_version (bool, optional): Whether to ignore the transcript version. Defaults to True.