Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
niemasd authored Mar 5, 2024
1 parent 8c35bda commit fe7cc26
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,18 +56,27 @@ usage: ViralMSA.py [-h] -s SEQUENCES -r REFERENCE -e EMAIL -o OUTPUT [-a ALIGNER
-u, --update Update ViralMSA (default: False)
```

### GenBank Accession Number
For the reference genome, you can provide a GenBank accession number, such as the following:

```
ViralMSA.py -e [email protected] -s sequences.fas -o output -r NC_045512
```

### Preselected Reference Genomes
For specific viruses of interest, you can simply use their name, and we have provided what we believe would be a good choice of reference genome, such as the following:

```
ViralMSA.py -e [email protected] -s sequences.fas -o output -r SARS-CoV-2
```

Our preselected viral reference genomes can be found in the following GitHub repository:

https://github.com/Niema-Lab/Reference-Genomes

If you would like to contribute a new or updated viral reference genome to our collection, please feel free to submit a [GitHub Issue](https://github.com/Niema-Lab/Reference-Genomes/issues/new) or a [Pull Request](https://github.com/Niema-Lab/Reference-Genomes/pulls) with all relevant information.

### Local File
If you have a local reference genome you would like to use, you can provide the path to a FASTA file with a single sequence, such as the following:

```
Expand Down

0 comments on commit fe7cc26

Please sign in to comment.