Skip to content

Commit 0073a33

Browse files
committedNov 23, 2023
Update documentation and fix a few typos ahead of release
1 parent de17c6c commit 0073a33

File tree

6 files changed

+10
-10
lines changed

6 files changed

+10
-10
lines changed
 

‎docs/Documentation.docx

-19.9 KB
Binary file not shown.

‎docs/Documentation.pdf

28.2 KB
Binary file not shown.

‎docs/html/Documentation.html

+1-1
Large diffs are not rendered by default.

‎docs/html/images/image1.png

-19.4 KB
Loading

‎docs/html/images/image2.png

-7.18 KB
Loading

‎hlsmallrna/__main__.py

+9-9
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ def sort_command(genome, small_rna, cds, min_length, max_length, num_mismatches,
121121

122122
def extractnc_command(genome, gff, quiet):
123123
'''
124-
Code to run when the user chooses to extract the noncoding mRNA reigon
124+
Code to run when the user chooses to extract the noncoding mRNA region
125125
'''
126126

127127
if not validate_file(genome, 'fasta'):
@@ -238,17 +238,17 @@ def main():
238238
parser_process.add_argument('small_rna', help='Path to FASTQ containing the small RNA')
239239

240240
parser_sort = subparsers.add_parser('sort', help='Find RNAs that align to a genome and sort them by length')
241-
parser_sort.add_argument('-d', '--cds', help='Optional CDS region, also align this to the CDS reigon as well as the genome')
241+
parser_sort.add_argument('-d', '--cds', help='Optional CDS region, also align this to the CDS region as well as the genome')
242242
parser_sort.add_argument('-l', '--min-length', help='Minimum length to bin', type=int, default=-inf)
243243
parser_sort.add_argument('-x', '--max-length', help='Maximum length to bin', type=int, default=inf)
244-
parser_sort.add_argument('-m', '--ref-mismatches', type=int, default=None, help='Number of mismatches to use in bowtie2, None for default behavior')
245-
parser_sort.add_argument('--disable-alignment', action='store_true', help='Skip the alignment to the refernce genome step')
244+
parser_sort.add_argument('-m', '--ref-mismatches', type=int, default=None, help='Number of mismatches to use in bowtie2, None for default behaviour')
245+
parser_sort.add_argument('--disable-alignment', action='store_true', help='Skip the alignment to the reference genome step')
246246
parser_sort.add_argument('small_rna', help='Path to FASTQ containing the small RNA')
247247
parser_sort.add_argument('genome', nargs='?', default=None, help='Genome to align against')
248248

249-
parser_extractnc = subparsers.add_parser('extractnc', help='Extarct the noncoding reigon from a fasta with a GFF file')
249+
parser_extractnc = subparsers.add_parser('extractnc', help='Extarct the noncoding region from a fasta with a GFF file')
250250
parser_extractnc.add_argument('genome', help='FASTA containing the genome to extract from')
251-
parser_extractnc.add_argument('gff_file', help='GFF file containing annotations of CDS and mRNA reigons')
251+
parser_extractnc.add_argument('gff_file', help='GFF file containing annotations of CDS and mRNA regions')
252252

253253
parser_unitas = subparsers.add_parser('unitas', help='Run unitas on split files and merge results')
254254
parser_unitas.add_argument('-d', '--cds', help='Optional CDS region, passed to unitas')
@@ -265,7 +265,7 @@ def main():
265265

266266
parser_all = subparsers.add_parser('all', help='Run process, sort and unitas one after the other')
267267
parser_all.add_argument('-a', '--adapter', help='Sequence of the adapter to remove from the 3\' end')
268-
parser_all.add_argument('-d', '--cds', help='Optional CDS region, also align this to the CDS reigon as well as the genome')
268+
parser_all.add_argument('-d', '--cds', help='Optional CDS region, also align this to the CDS region as well as the genome')
269269
parser_all.add_argument('-g', '--front', help='Sequence of the adapter to remove from the 5\' end')
270270
parser_all.add_argument('-b', '--anywhere', help='Sequence of the adapters to remove from both ends')
271271
parser_all.add_argument('-c', '--cutoff', help='Quality cutoff to trin RNA sequences at', default=20, type=int)
@@ -274,8 +274,8 @@ def main():
274274
parser_all.add_argument('-r', '--refseq', help='References for use with unitas', nargs='*', default=None)
275275
parser_all.add_argument('-s', '--species', help='Species to set in unitas arguments', default='x')
276276
parser_all.add_argument('-u', '--unspliced-transcriptome', help='Optional, unspliced transcriptome, passed to unitas')
277-
parser_all.add_argument('-m', '--ref-mismatches', type=int, default=None, help='Number of mismatches to use in bowtie2 when aligning to the genome, None for default behavior')
278-
parser_all.add_argument('--disable-alignment', action='store_true', help='Skip the alignment to the refernce genome step')
277+
parser_all.add_argument('-m', '--ref-mismatches', type=int, default=None, help='Number of mismatches to use in bowtie2 when aligning to the genome, None for default behaviour')
278+
parser_all.add_argument('--disable-alignment', action='store_true', help='Skip the alignment to the reference genome step')
279279
parser_all.add_argument('small_rna', help='Path to FASTQ containing the small RNA')
280280
parser_all.add_argument('genome', nargs='?', default=None, help='Genome to align against')
281281

0 commit comments

Comments
 (0)