Skip to content

Commit

Permalink
docs: add example to README
Browse files Browse the repository at this point in the history
  • Loading branch information
boasvdp committed Apr 26, 2024
1 parent 830f9c4 commit 17b6cca
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,18 @@ assembly_snptyper --version
Note that:
- the reference VCF must be based on the reference genome (i.e. identical chromosome names).
- the list of input files must be a file list of paths to assemblies. This is to accomodate running the script on large numbers of files
- the reference fasta must be unzipped

### Example

Running `assembly_snptyper` for *S. pyogenes* M1UK, with paths to genome assemblies listed in `fastas.txt`:

```
assembly_snptyper --vcf data/M1UK.vcf --reference data/MGAS5005.fa --list_input fastas.txt -p 4 --verbose > output.txt
```


## Help message

```
assembly_snptyper --help
Expand Down

0 comments on commit 17b6cca

Please sign in to comment.