diff --git a/README.md b/README.md index a5fe9bf..b01ea4e 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ trim_trailing: remove ORFs are the edge of the sequence that do not have a defin **getORFNucleotides()** ``` -Returns the loci of discovered ORFs in a dictionary format. +Returns a list of Biopython Seq objects or loci of discovered ORFs with Biopython Seq objects in a dictionary format. sequence: sequence in Biopython Seq or String format. return_loci: return the loci together with the nucleotide sequences. Default: False @@ -43,7 +43,7 @@ trim_trailing: remove ORFs are the edge of the sequence that do not have a defin **getORFProteins()** ``` -Returns the loci of discovered ORFs in a dictionary format. +Returns a list of Biopython Seq objects or loci of discovered ORFs with Biopython Seq objects in a dictionary format. sequence: sequence in Biopython Seq or String format. translation_table: translation table as per BioPython. Default: 1 diff --git a/orffinder/orffinder.py b/orffinder/orffinder.py index 61a3f44..c4d78df 100644 --- a/orffinder/orffinder.py +++ b/orffinder/orffinder.py @@ -146,7 +146,7 @@ def findSense (sequence, sense="+", start_codons=["ATG"], stop_codons=["TAA", "T def getORFNucleotides (sequence, return_loci=False, **kwargs): """ - Returns the loci of discovered ORFs in a dictionary format. + Returns a list of Biopython Seq objects or loci of discovered ORFs with Biopython Seq objects in a dictionary format. sequence: sequence in Biopython Seq or String format. return_loci: return the loci together with the nucleotide sequences. Default: False @@ -188,7 +188,7 @@ def getORFNucleotides (sequence, return_loci=False, **kwargs): def getORFProteins (sequence, translation_table=1, return_loci=False, **kwargs): """ - Returns the loci of discovered ORFs in a dictionary format. + Returns a list of Biopython Seq objects or loci of discovered ORFs with Biopython Seq objects in a dictionary format. sequence: sequence in Biopython Seq or String format. translation_table: translation table as per BioPython. Default: 1