Mercurial > repos > jpayne > seqsero_v2

comparison SeqSero2/README.md @ 1:fae43708974d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload
author jpayne
date Fri, 09 Nov 2018 11:30:45 -0500
parents
children 87c7eebc6797
comparison
equal deleted inserted replaced
0:4ff2aee11e5b 1:fae43708974d
1 # SeqSero2 alpha-test version
2 Salmonella serotyping from genome sequencing data
3
4
5 # Introduction
6 SeqSero2 is a pipeline for Salmonella serotype determination from raw sequencing reads or genome assemblies. This is a alpha test version. A web app will be available soon.
7
8
9 # Dependencies
10 SeqSero has two modes:
11
12
13 (A) k-mer based mode (default), which applies unique k-mers of serotype determinant alleles to determine Salmonella serotypes in a fast speed. Special thanks to Dr. Hendrik Den Bakker for his significant contribution to this mode, details can be found in [SeqSeroK](https://github.com/hcdenbakker/SeqSeroK) and [SalmID](https://github.com/hcdenbakker/SalmID).
14
15 K-mer mode is a independant pipeline, it only requires:
16
17 1. Python 3;
18 2. [SRA Toolkit](http://www.ncbi.nlm.nih.gov/Traces/sra/sra.cgi?cmd=show&f=software&m=software&s=software) (optional, just used to fastq-dump sra files);
19
20
21 (B) allele based mode (if users want to extract serotype determinant alleles), which applies a hybrid approach of reads-mapping and micro-assembly.
22
23 Allele mode depends on:
24
25 1. Python 3;
26
27 2. [Burrows-Wheeler Aligner](http://sourceforge.net/projects/bio-bwa/files/);
28
29 3. [Samtools](http://sourceforge.net/projects/samtools/files/samtools/);
30
31 4. [NCBI BLAST](https://blast.ncbi.nlm.nih.gov/Blast.cgi?PAGE_TYPE=BlastDocs&DOC_TYPE=Download);
32
33 5. [SRA Toolkit](http://www.ncbi.nlm.nih.gov/Traces/sra/sra.cgi?cmd=show&f=software&m=software&s=software);
34
35 6. [SPAdes](http://bioinf.spbau.ru/spades);
36
37 7. [Bedtools](http://bedtools.readthedocs.io/en/latest/);
38
39 8. [SalmID](https://github.com/hcdenbakker/SalmID).
40
41
42 # Executing the code
43 Make sure all SeqSero2 and its dependency executables are added to your path (e.g. to ~/.bashrc). Then type SeqSero2_package.py to get detailed instructions.
44
45 Usage: SeqSero2_package.py
46
47 -m <string> (which mode to apply, 'k'(kmer mode), 'a'(allele mode), default=k)
48
49 -t <string> (input data type, '1' for interleaved paired-end reads, '2' for separated paired-end reads, '3' for single reads, '4' for genome assembly, '5' for nanopore fasta, '6'for nanopore fastq)
50
51 -i <file> (/path/to/input/file)
52
53 -p <int> (number of threads for allele mode, if p >4, only 4 threads will be used for assembly since the amount of extracted reads is small, default=1)
54
55 -b <string> (algorithms for bwa mapping for allele mode; 'mem' for mem, 'sam' for samse/sampe; default=mem; optional; for now we only optimized for default "mem" mode)
56
57 -d <string> (output directory name, if not set, the output directory would be 'SeqSero_result_'+time stamp+one random number)
58
59 -c <flag> (if '-c' was flagged, SeqSero2 will use clean mode and only output serotyping prediction without the directory containing log files)
60
61
62 # Examples
63 K-mer mode:
64
65 # K-mer (default), for separated paired-end raw reads ("-t 2")
66 SeqSero2_package.py -t 2 -i R1.fastq.gz R2.fastq.gz
67
68 # K-mer (default), for assemblies ("-t 4", assembly only predcited by K-mer mode)
69 SeqSero2_package.py -t 4 -i assembly.fasta
70
71 Allele mode:
72
73 # Allele mode ("-m a"), for separated paired-end raw reads ("-t 2"), use 10 threads in mapping and assembly ("-p 10")
74 SeqSero2_package.py -m a -p 10 -t 2 -i R1.fastq.gz R2.fastq.gz
75
76
77 # Output
78 Upon executing the command, a directory named 'SeqSero_result_Time_your_run' will be created. Your result will be stored in 'Seqsero_result.txt' in that directory. And the assembled alleles can also be found in the directory if using "-m a" (allele mode).
79
80
81 # Citation
82 Zhang S, Yin Y, Jones MB, Zhang Z, Deatherage Kaiser BL, Dinsmore BA, Fitzgerald C, Fields PI, Deng X.
83 Salmonella serotype determination utilizing high-throughput genome sequencing data.
84 **J Clin Microbiol.** 2015 May;53(5):1685-92.[PMID:25762776](http://jcm.asm.org/content/early/2015/03/05/JCM.00323-15)