Skip to content

Commit 682941d

Browse files
committed
Merge pull request #18 from bewt85/bt5-clean-up-readme
Reformat README
2 parents 81ccbc4 + 8bb22ab commit 682941d

File tree

1 file changed

+17
-21
lines changed

1 file changed

+17
-21
lines changed

README.md

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,36 @@
11
[![Build Status](https://travis-ci.org/sanger-pathogens/snp_sites.png?branch=master)](https://travis-ci.org/sanger-pathogens/snp_sites)
2-
SNP Sites
3-
=====
2+
# SNP Sites
43
This program finds snp sites from a multi fasta alignment file.
54

6-
5+
```
76
Usage: snp-sites [-mvph] [-o output_filename] <file>
87
This program finds snp sites from a multi fasta alignment file.
9-
-m output a multi fasta alignment file (default)
10-
-v output a VCF file
11-
-p output a phylip file
12-
-o specify an output filename
13-
-h this help message
8+
-m output a multi fasta alignment file (default)
9+
-v output a VCF file
10+
-p output a phylip file
11+
-o specify an output filename
12+
-h this help message
1413
<file> input alignment file which can optionally be gzipped
15-
14+
```
1615

1716
This application takes in a multi fasta alignment, finds all the SNP sites, then outputs the SNP sites in the following formats:
1817

19-
a multi fasta alignment,
20-
VCF,
21-
relaxed phylip format.
18+
- a multi fasta alignment,
19+
- VCF,
20+
- relaxed phylip format.
2221

23-
Example usage:
22+
### Example usage
2423

24+
```
2525
snp-sites my_alignment.aln
26-
2726
snp-sites my_gzipped_alignment.aln.gz
27+
```
2828

29-
30-
Multi Fasta Alignment
31-
=====
29+
### Multi Fasta Alignment
3230
Similar to the input file but just containing the SNP sites.
3331

34-
VCF
35-
=====
32+
### VCF
3633
This contains the position of each SNP in the reference sequence, and the occurrence in each other sample. Can be loaded into Artemis for visualisation.
3734

38-
Relaxed Phylip format
39-
=====
35+
### Relaxed Phylip format
4036
All the SNP sites in a format for RAxML and other tree building applications.

0 commit comments

Comments
 (0)