Skip to content

Commit 5462671

Browse files
committed
updated readme
1 parent d557703 commit 5462671

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,42 +15,42 @@ Download the latest POGENOM distribution from https://github.com/EnvGen/POGENOM/
1515

1616
Either:
1717

18-
`perl pogenom.pl --vcf_file VCF_FILE --out OUTPUT_FILES_PREFIX --genome_size GENOME_SIZE [-h]`
18+
`perl pogenom.pl --vcf_file VCF_FILE --out OUTPUT_FILES_PREFIX --genome_size GENOME_SIZE [--help]`
1919

2020
Or:
2121

22-
`perl pogenom.pl -vcf_file VCF_FILE --out OUTPUT_FILES_PREFIX --gff_file GFF_FILE [-h]`
22+
`perl pogenom.pl -vcf_file VCF_FILE --out OUTPUT_FILES_PREFIX --gff_file GFF_FILE [--help]`
2323

2424

2525

2626
### Required arguments
2727

28-
`--vcf_file VCF_FILE` Specify vcf file with data from a single or multiple samples.
28+
`--vcf_file VCF_FILE` Specify vcf file with data from a single or multiple samples.
2929

30-
`--out OUTPUT_FILES_PREFIX` Specify the prefix of the output file name(s) (overwrites existing files with same names).
30+
`--out OUTPUT_FILES_PREFIX` Specify the prefix of the output file name(s) (overwrites existing files with same names).
3131

32-
`--genome_size GENOME_SIZE` Specify genome size (in bp; integer). Not required if `--gff_file` is given.
32+
`--genome_size GENOME_SIZE` Specify genome size (in bp; integer). Not required if `--gff_file` is given.
3333

3434

3535

3636
### Optional arguments
3737

38-
`--gff_file GFF_FILE` Specify gff file. Either this or `--genome_size` must be given.
38+
`--gff_file GFF_FILE` Specify gff file. Either this or `--genome_size` must be given.
3939

4040
`--genetic_code_file GENETIC_CODE_FILE` Specify genetic code file. E.g. `standard_genetic_code.txt` in the POGENOM distribution.
4141

42-
`--loci_file LOCI_FILE` Specify file with ids for loci to include.
42+
`--loci_file LOCI_FILE` Specify file with ids for loci to include.
4343

44-
`--min_count MIN_COUNT` Specify minimum coverage for a locus to be included for the sample.
44+
`--min_count MIN_COUNT` Specify minimum coverage for a locus to be included for the sample.
4545

46-
`--min_found MIN_FOUND_IN` Specify minimum number samples that a locus need to be present in to be included.
46+
`--min_found MIN_FOUND_IN` Specify minimum number samples that a locus need to be present in to be included.
4747

48-
`--subsample SUBSAMPLE` Specify coverage level at which to subsample.
48+
`--subsample SUBSAMPLE` Specify coverage level at which to subsample.
4949

50-
`--keep_haplotypes` If this is used, POGENOM will not split haplotypes into single-nucleotide variants, which is otherwise the default behaviour.
51-
`--vcf_version` Specify VCF file format version. Can be set to 4.2 or 4.1 (default).
50+
`--keep_haplotypes` If this is used, POGENOM will not split haplotypes into single-nucleotide variants, which is otherwise the default behaviour.
51+
`--vcf_version` Specify VCF file format version. Can be set to 4.2 or 4.1 (default).
5252

53-
`-h` To print help message on screen.
53+
`--help` To print help message on screen.
5454

5555
----
5656

0 commit comments

Comments
 (0)