annotate SeqSero/README.md @ 0:c577b57b7c74 draft

Uploaded
author estrain
date Wed, 06 Dec 2017 15:59:29 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
1 # SeqSero 1.0
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
2 Salmonella serotyping from genome sequencing data
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
3
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
4
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
5 # Introduction
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
6 SeqSero is a pipeline for Salmonella serotype determination from raw sequencing reads or genome assemblies. A web app is available at www.denglab.info/SeqSero
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
7
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
8 # Dependencies
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
9 SeqSero depends on:
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
10
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
11 1. Python 2.7 and [Biopython 1.65](http://biopython.org/wiki/Download);
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
12
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
13 2. [Burrows-Wheeler Aligner](http://sourceforge.net/projects/bio-bwa/files/);
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
14
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
15 3. [Samtools](http://sourceforge.net/projects/samtools/files/samtools/);
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
16
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
17 4. [NCBI BLAST](https://blast.ncbi.nlm.nih.gov/Blast.cgi?PAGE_TYPE=BlastDocs&DOC_TYPE=Download);
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
18
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
19 5. [SRA Toolkit](http://www.ncbi.nlm.nih.gov/Traces/sra/sra.cgi?cmd=show&f=software&m=software&s=software);
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
20
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
21 6. [isPcr](http://hgwdev.cse.ucsc.edu/~kent/exe/linux/) written by Jim Kent.
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
22
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
23 # Executing the code
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
24 Usage: SeqSero.py
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
25
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
26 -m <int> (input data type, '1' for interleaved paired-end reads , '2' for separated paired-end reads, '3' for single reads, '4' for genome assembly)
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
27
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
28 -i <file> (/path/to/input/file)
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
29
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
30 -b <string> (algorithms for bwa mapping; 'mem' for mem, 'sam' for samse/sampe; default=sam; optional)
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
31
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
32 # Output
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
33 Upon executing the command, a directory named 'SeqSero_result_<time_you_run_SeqSero>' will be created. Your result will be stored in 'Seqsero_result.txt' in that directory
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
34
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
35 # Citation
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
36 Zhang S, Yin Y, Jones MB, Zhang Z, Deatherage Kaiser BL, Dinsmore BA, Fitzgerald C, Fields PI, Deng X.
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
37 Salmonella serotype determination utilizing high-throughput genome sequencing data.
c577b57b7c74 Uploaded
estrain
parents:
diff changeset
38 **J Clin Microbiol.** 2015 May;53(5):1685-92.[PMID:25762776](http://jcm.asm.org/content/early/2015/03/05/JCM.00323-15)