annotate README.md @ 0:4ff2aee11e5b

planemo upload
author jpayne
date Tue, 06 Nov 2018 09:45:57 -0500
parents
children
rev   line source
jpayne@0 1 # SeqSero2 alpha-test version
jpayne@0 2 Salmonella serotyping from genome sequencing data
jpayne@0 3
jpayne@0 4
jpayne@0 5 # Introduction
jpayne@0 6 SeqSero2 is a pipeline for Salmonella serotype determination from raw sequencing reads or genome assemblies. This is a alpha test version. For now, it can only accept separated paired-end reads. A web app will be available soon.
jpayne@0 7
jpayne@0 8 # Dependencies
jpayne@0 9 SeqSero depends on:
jpayne@0 10
jpayne@0 11 1. Python 2.7 and [Biopython 1.65](http://biopython.org/wiki/Download);
jpayne@0 12
jpayne@0 13 2. [Burrows-Wheeler Aligner](http://sourceforge.net/projects/bio-bwa/files/);
jpayne@0 14
jpayne@0 15 3. [Samtools](http://sourceforge.net/projects/samtools/files/samtools/);
jpayne@0 16
jpayne@0 17 4. [NCBI BLAST](https://blast.ncbi.nlm.nih.gov/Blast.cgi?PAGE_TYPE=BlastDocs&DOC_TYPE=Download);
jpayne@0 18
jpayne@0 19 5. [SRA Toolkit](http://www.ncbi.nlm.nih.gov/Traces/sra/sra.cgi?cmd=show&f=software&m=software&s=software);
jpayne@0 20
jpayne@0 21 6. [SPAdes](http://bioinf.spbau.ru/spades);
jpayne@0 22
jpayne@0 23 7. [Bedtools](http://bedtools.readthedocs.io/en/latest/).
jpayne@0 24
jpayne@0 25 # Executing the code
jpayne@0 26 Usage: SeqSero2.py
jpayne@0 27
jpayne@0 28 -p <int> (number of threads, if p >4, only 4 threads will be used for assembly since the amount of extracted reads is small, default=1)
jpayne@0 29
jpayne@0 30 -i <file> (/path/to/input/file; for now, SeqSero2 only accepts separated paired-end reads )
jpayne@0 31
jpayne@0 32 -b <string> (algorithms for bwa mapping; 'mem' for mem, 'sam' for samse/sampe; default=mem; optional; for now SeqSero2 is only optimized for "mem" mode)
jpayne@0 33
jpayne@0 34 # Output
jpayne@0 35 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.
jpayne@0 36
jpayne@0 37 # Citation
jpayne@0 38 Zhang S, Yin Y, Jones MB, Zhang Z, Deatherage Kaiser BL, Dinsmore BA, Fitzgerald C, Fields PI, Deng X.
jpayne@0 39 Salmonella serotype determination utilizing high-throughput genome sequencing data.
jpayne@0 40 **J Clin Microbiol.** 2015 May;53(5):1685-92.[PMID:25762776](http://jcm.asm.org/content/early/2015/03/05/JCM.00323-15)
jpayne@0 41