annotate compare2sequences.xml @ 7:ca68df041d0d draft default tip

planemo upload
author alperkucukural
date Wed, 04 Nov 2015 16:46:58 -0500
parents 10db17004ffa
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
1 <tool id="compare2sequences" name="compare2sequences" version="1.0.0">
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
2 <description>CRISPRSeek compare2sequences</description>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
3 <macros>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
4 <import>crisprseek_macros.xml</import>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
5 </macros>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
6 <expand macro="requirements" />
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
7 <command detect_errors="exit_code">
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
8 Rscript "${compare2sequences}"
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
9 </command>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
10 <configfiles>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
11 <configfile name="compare2sequences"><![CDATA[
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
12 ## code chunk: Load all required libraries quietly
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
13 library(CRISPRseek, quietly=TRUE, warn.conflicts=FALSE,verbose = FALSE)
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
14
7
ca68df041d0d planemo upload
alperkucukural
parents: 6
diff changeset
15 compare2Sequences("${inputfile1}", "${inputfile2}", inputNames=c("Seq1", "Seq2"), REpatternFile = system.file('extdata', 'NEBenzymes.fa', package = 'CRISPRseek'), max.mismatch="${maxmismatch}", searchDirection="both", findPairedgRNAOnly=${a.fg.fpg_only}, min.gap = "${a.fg.mingap}", max.gap = "${a.fg.maxgap}", gRNA.name.prefix = "gRNA", PAM.size = "${a.PAMsize}", gRNA.size = "${a.gRNAsize}", PAM = "${a.PAM}", PAM.pattern = "${a.PAMPattern}", outputDir="./", weights="${a.weights}" )
6
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
16
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
17 ]]></configfile>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
18 </configfiles>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
19 <inputs>
7
ca68df041d0d planemo upload
alperkucukural
parents: 6
diff changeset
20 <param format="fastq,fa,fasta" name="inputfile1" type="data" label="Input File Path" />
ca68df041d0d planemo upload
alperkucukural
parents: 6
diff changeset
21 <param format="fastq,fa,fasta" name="inputfile2" type="data" label="Input File Path" />
6
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
22 <param name="maxmismatch" type="text" label="Max Mismatch" value="3" help="Maximum mismatch allowed in off target search, default 3. Warning: will be considerably slower if set > 3"/>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
23 <conditional name="a">
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
24 <param name="advanced" type="select" label="Advanced Options">
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
25 <option value="No" selected="True">No</option>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
26 <option value="Yes">Yes</option>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
27 </param>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
28 <when value="Yes">
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
29 <param name="searchDirection" type="select" label="Search Direction">
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
30 <option value="both" selected="True">both</option>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
31 <option value="1to2">1to2</option>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
32 <option value="2to1">2to1</option>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
33 </param>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
34 <conditional name="fg">
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
35 <param name="fpg_only" type="select" label="Find Paired gRNA Only" help="Choose whether to only search for paired gRNAs in such an orientation that the first one is on minus strand called reverse gRNA and the second one is on plus strand called forward gRNA. TRUE or FALSE, default FALSE">
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
36 <option value="FALSE" selected="True">No</option>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
37 <option value="TRUE">Yes</option>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
38 </param>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
39 <when value="True">
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
40 <param name="mingap" type="text" label="Min Gap" value="0" />
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
41 <param name="maxgap" type="text" label="Max Gap" value="20" />
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
42 </when>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
43 </conditional>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
44 <param name="PAMsize" type="text" label="PAM Size" value="3" help="PAM length, default 3"/>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
45 <param name="PAM" type="text" label="PAM" value="NGG" help="PAM sequence after the gRNA, default NGG"/>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
46 <param name="PAMPattern" type="text" label="PAM Pattern" value="N[A_p_G]G_d_" help="Regular expression of protospacer-adjacent motif (PAM), default N[A|G]G$. Please use _p_ for | and _d_ for $ symbols"/>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
47 <param name="gRNAsize" type="text" label="gRNA Size" value="20" help="The size of the gRNA, default 20"/>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
48 <param name="weights" type="text" area="true" size="5x60" value="0, 0, 0.014, 0, 0, 0.395, 0.317, 0, 0.389, 0.079, 0.445, 0.508, 0.613, 0.851, 0.732, 0.828, 0.615, 0.804, 0.685, 0.583" label="Off Target Weights" help="a numeric vector size of gRNA length, default 0, 0, 0.014, 0, 0, 0.395, 0.317, 0, 0.389, 0.079, 0.445, 0.508, 0.613, 0.851, 0.732, 0.828, 0.615, 0.804, 0.685, 0.583 which is used in Hsu et al., 2013 cited in the reference section"/>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
49 </when>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
50 </conditional>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
51 </inputs>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
52 <outputs>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
53 <data format="gz" name="output"/>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
54 </outputs>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
55 <help>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
56
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
57 **What it does**
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
58
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
59 The package includes functions to find potential guide RNAs for input target se-
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
60 quences, optionally filter guide RNAs without restriction enzyme cut site, or with-
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
61 out paired guide RNAs, genome-wide search for off-targets, score, rank, fetch flank se-
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
62 quence and indicate whether the target and off-targets are located in exon region or not. Poten-
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
63 tial guide RNAs are annotated with total score of the top5 and topN off-targets, de-
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
64 tailed topN mismatch sites, restriction enzyme cut sites, and paired guide RNAs.
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
65
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
66 **Description**
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
67
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
68 Generate all possible guide RNAs (gRNAs) for two input sequences, or two sets of sequences and generate scores for potential off-targets in the other sequence.
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
69
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
70 **Usage**
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
71
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
72 compare2Sequences(inputFile1Path, inputFile2Path, inputNames=c("Seq1", "Seq2"), format = "fasta", findgRNAsWithREcutOnly = FALSE, searchDirection=c("both","1to2", "2to1"), REpatternFile=system.file("extdata", "NEBenzymes.fa", package = "CRISPRseek"), minREpatternSize = 6, overlap.gRNA.positions = c(17, 18), findPairedgRNAOnly = FALSE, min.gap = 0, max.gap = 20, gRNA.name.prefix = "gRNA", PAM.size = 3, gRNA.size = 20, PAM = "NGG", PAM.pattern = "N[A|G]G$", max.mismatch = 3, outputDir, weights = c(0, 0, 0.014, 0, 0, 0.395, 0.317, 0, 0.389, 0.079, 0.445, 0.508, 0.613, 0.851, 0.732, 0.828, 0.615, 0.804, 0.685, 0.583), overwrite = FALSE)
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
73
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
74 **Author(s)**
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
75
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
76 Lihua Julie Zhu and Michael Brodsky Maintainer: julie.zhu@umassmed.edu
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
77
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
78 Alper Kucukural, Galaxy Maintainer: alper.kucukural@umassmed.edu
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
79
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
80 **Citation**
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
81
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
82 (from within R, enter citation("CRISPRseek")):
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
83
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
84 Zhu LJ, Holmes BR, Aronin N and Brodsky MH (2014). “CRISPRseek: A Bioconductor Package to Identify Target-Specific Guide RNAs for CRISPR-Cas9 Genome-Editing Systems.” PLoS one, 9(9). http://www.ncbi.nlm.nih.gov/pmc/articles/PMC4172692/.
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
85
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
86 **References**
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
87
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
88 Patrick D Hsu, David A Scott, Joshua A Weinstein, F Ann Ran, Silvana Konermann, Vineeta Agar-
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
89 wala, Yinqing Li, Eli J Fine, Xuebing Wu, Ophir Shalem, Thomas J Cradick, Luciano A Marraffini,
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
90 Gang Bao, Feng Zhang (2013) DNA targeting specificity of rNA-guided Cas9 nucleases. Nature
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
91 Biotechnology 31:827-83
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
92
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
93 Mali P, Aach J, Stranges PB, Esvelt KM, Moosburner M, Kosuri S, Yang L, Church GM.CAS9
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
94 transcriptional activators for target specificity screening and paired nickases for cooperative genome
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
95 engineering. Nat Biotechnol. 2013. 31(9):833-8 Patrick D Hsu, David A Scott, Joshua A Wein-
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
96 stein, F Ann Ran, Silvana Konermann, Vineeta Agarwala, Yinqing Li, Eli J Fine, Xuebing Wu,
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
97 Ophir Shalem, Thomas J Cradick, Luciano A Marraffini, Gang Bao, Feng Zhang. DNA targeting
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
98 specificity of rNA-guided Cas9 nucleases. Nat Biotechnol. 2013. 31:827-834
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
99
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
100 **Reference Manual and Materials**
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
101
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
102 http://www.bioconductor.org/packages/release/bioc/vignettes/CRISPRseek/inst/doc/CRISPRseek.pdf
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
103
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
104 http://www.bioconductor.org/packages/release/bioc/manuals/CRISPRseek/man/CRISPRseek.pdf
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
105
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
106 http://www.bioconductor.org/packages/release/bioc/vignettes/CRISPRseek/inst/doc/CRISPRseek.R
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
107
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
108
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
109
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
110
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
111
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
112 </help>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
113 <expand macro="citations" />
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
114
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
115 </tool>
10db17004ffa planemo upload
alperkucukural
parents:
diff changeset
116