DMU-lilab / pTrimmer

Used to trim off the primer sequence from mutiplex amplicon sequencing
GNU General Public License v3.0
21 stars 5 forks source link

Spelling errors in command line help #18

Closed peterjc closed 2 years ago

peterjc commented 2 years ago
$ ptrimmer
[Err::ParseOpt::86] Please give the [requied] parmeters!

Usage: pTrimmer [options]
Version: 1.3.3

Options:
       -h|--help        print help infomation
       -l|--keep        keep the complete reads if failed to locate primer
                        sequence [default: discard the reads]
       -t|--seqtype     [required] the sequencing type [single|pair]
       -a|--ampfile     [required] input amplicon file [.txt]
       -f|--read1       [required] read1(forward) for fastq file [.fq|.gz]
       -d|--trim1       [required] the trimed read1 of fastq file
       -r|--read2       [optional] read2(reverse) for fastq file (paired-end seqtype) [.fq|.gz]
       -e|--trim2       [optional] the trimed read2 of fastq file (paired-end seqtype)
       -s|--summary     [optional] the trimming information of each amplicon [default: Summary.ampcount]
       -q|--minqual     [optional] the minimum average quality to keep after triming [20]
       -k|--kmer        [optional] the kmer lenght for indexing [8]
       -m|--mismatch    [optional] the maxmum mismatch for primer seq [3]

requied -> required parmeters -> parameters infomation -> information trimed -> trimmed triming -> trimming lenght -> length maxmum -> maximum

I've found https://github.com/codespell-project/codespell very useful, that might be worth trying?

XLZH commented 2 years ago

Thanks for your feedback! I have corrected these spelling errors you mentioned above and will be drafting a new release in the next version.