Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
campanam authored Aug 15, 2019
1 parent 7b179e0 commit ca9e1e2
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# vcf2aln
Script to convert multi-sample VCFs to FASTA alignments without assuming the reference sequence when data are missing. Users can apply a variety of data filters, produce phased/unphased, concatenated/split alignments, etc.
Script to convert multi-sample VCFs to FASTA alignments without assuming the reference sequence when data are missing. Users can apply a variety of data filters, produce phased/unphased, concatenated/split alignments, etc. VCF data can be read either from previously generated files or from piped uncompressed VCF streams.

## Authors
Michael G. Campana & Jacob A. West-Roberts, 2017-2019
Expand Down Expand Up @@ -28,6 +28,7 @@ Execute the script using `ruby vcf2aln.rb` (or `vcf2aln.rb` if the script is in
## Available options
### I/O options:
`-i, --input [FILE]`: Input VCF file.
`--pipe`: Read data from an uncompressed VCF stream rather than a file.
`-o, --outprefix [VALUE]`: Output FASTA alignment prefix.
`-c, --concatenate`: Concatenate markers into single alignment (e.g. concatenate multiple separate chromosomes/contigs).
`-s, --skip`: Skip missing sites in VCF.
Expand Down

0 comments on commit ca9e1e2

Please sign in to comment.