Mercurial > repos > alperkucukural > crisprseek

comparison CRISPRSeek/offtargetanalysis.xml @ 1:8615e7e7c5be draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author alperkucukural
date Mon, 02 Nov 2015 10:38:57 -0500
parents
children
comparison
equal deleted inserted replaced
0:e68ce5e837bc 1:8615e7e7c5be
1 <tool id="offTargetAnalysis" name="Off Target Analysis" version="1.0.0">
2 <description>CRISPRSeek offTargetAnalysis</description>
3 <macros>
4 <import>crisprseek_macros.xml</import>
5 </macros>
6 <expand macro="requirements" />
7 <command detect_errors="exit_code">
8 Rscript "${offTargetAnalysis}"
9 </command>
10 <configfiles>
11 <configfile name="offTargetAnalysis"><![CDATA[
12 ## code chunk: Load all required libraries quietly
13 library(CRISPRseek, quietly=TRUE, warn.conflicts=FALSE,verbose = FALSE)
14
15 offTargetAnalysis("${s.inputfile}", BSgenomeName="BSgenome.Hsapiens.UCSC.hg19", txdb ="TxDb.Hsapiens.UCSC.hg19.knownGene",orgAnn="org.Hs.egSYMBOL", REpatternFile = system.file('extdata', 'NEBenzymes.fa', package = 'CRISPRseek'), max.mismatch="${maxmismatch}", exportAllgRNAs="${a.exportAllgRNAs}", searchDirection="${a.searchDirection}", 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}", chromToSearch="${a.chromToSearch}", minscore="${a.minscore}", topN="${a.topN}", topNOfftargetTotalScore="${a.topNOfftargetTotalScore}", annotateExon="${a.annotateExon}", fetchSequence="${a.fs.fetchSequence}", downstream="${a.fs.downstream}", upstream="${a.fs.upstream}", outputDir, weights="${a.weights}" )
16
17 ]]></configfile>
18 </configfiles>
19 <inputs>
20 <param name="bsgenomename" type="select" label="BS Genome Name" help="BSgenome object. Please refer to available.genomes in BSgenome package. For example, BSgenome.Hsapiens.UCSC.hg19 for hg19, BSgenome.Mmusculus.UCSC.mm10 for mm10, BSgenome.Celegans.UCSC.ce6 for ce6, BSgenome.Rnorvegicus.UCSC.rn5 for rn5, BSgenome.Drerio.UCSC.danRer7 for Zv9, and BSgenome.Dmelanogaster.UCSC.dm3 for dm3">
21 <option value="hg19">hg19</option>
22 <option value="mm10">mm10</option>
23 <option value="ce10">ce10</option>
24 </param>
25 <conditional name="s">
26 <param name="input_source" type="select" label="Select Input File Path" help="Sequence input file path that contains sequences to be searched for potential gRNAs">
27 <option value="history">History</option>
28 <option value="Fasta">Fasta</option>
29 <option value="FullPath">Full Path</option>
30 </param>
31 <when value="history">
32 <param format="fastq,fa,fasta" name="inputfile" type="data" label="Input File Path" />
33 </when>
34 <when value="FullPath">
35 <param name="inputfile" type="text" area="true" size="2x60" label="Input File Path" help="Full path in the cluster"/>
36 </when>
37 <when value="Fasta">
38 <param name="inputfile" type="text" area="true" size="2x60" label="Input Fasta Sequence/s" help="Free text fasta sequences"/>
39 </when>
40 </conditional>
41 <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"/>
42 <param name="outputdir" type="text" area="true" size="2x60" label="Output Directory" help="Output directory in the cluster"/>
43 <conditional name="a">
44 <param name="advanced" type="select" label="Advanced Options">
45 <option value="No" selected="True">No</option>
46 <option value="Yes">Yes</option>
47 </param>
48 <when value="Yes">
49 <param name="exportAllgRNAs" type="select" label="Export All gRNAs" help="Indicate whether to output all potential gRNAs to a file in fasta format, genbank format or both. Default to both.">
50 <option value="all" selected="True">all</option>
51 <option value="fasta">fasta</option>
52 <option value="genbank">genbank</option>
53 <option value="no">no</option>
54 </param>
55 <conditional name="fg">
56 <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">
57 <option value="False" selected="True">No</option>
58 <option value="True">Yes</option>
59 </param>
60 <when value="True">
61 <param name="mingap" type="text" label="Min Gap" value="0" />
62 <param name="maxgap" type="text" label="Max Gap" value="20" />
63 </when>
64 </conditional>
65 <param name="PAMsize" type="text" label="PAM Size" value="3" help="PAM length, default 3"/>
66 <param name="PAM" type="text" label="PAM" value="NGG" help="PAM sequence after the gRNA, default NGG"/>
67 <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"/>
68 <param name="gRNAsize" type="text" label="gRNA Size" value="20" help="The size of the gRNA, default 20"/>
69 <param name="minscore" type="text" label="min Score" value="0.5" help="minimum score of an off target to included in the final output, default 0.5"/>
70 <param name="topN" type="text" label="topN" value="100" help="top N off targets to be included in the final output, default 100"/>
71 <param name="topNOfftargetTotalScore" type="text" label="topN OfftargetTotalScore" value="10" help="top N off target used to calculate the total off target score, default 10"/>
72 <param name="annotateExon" type="select" label="Annotate Exon" help="Choose whether or not to indicate whether the off target is inside an exon or not, default TRUE">
73 <option value="true" selected="True">True</option>
74 <option value="false">False</option>
75 </param>
76 <param name="chromToSearch" type="text" label="chromToSearch" value="all" help="Type chromosome (Ex: chrX)"/>
77
78 <conditional name="fs">
79 <param name="fetchSequence" type="select" label="Fetch Sequence" help="Fetch flank sequence of off target or not, default TRUE">
80 <option value="True" selected="True">True</option>
81 <option value="False">False</option>
82 </param>
83 <when value="True">
84 <param name="upstream" type="text" label="upstream" value="200" help="upstream offset from the off target start, default 200"/>
85 <param name="downstream" type="text" label="downstream" value="200" help="downstream offset from the off target end default 200"/>
86 </when>
87 </conditional>
88 <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"/>
89 </when>
90 </conditional>
91 </inputs>
92 <outputs>
93 <data format="gz" name="output"/>
94 </outputs>
95 <help>
96
97 **What it does**
98
99 The package includes functions to find potential guide RNAs for input target se-
100 quences, optionally filter guide RNAs without restriction enzyme cut site, or with-
101 out paired guide RNAs, genome-wide search for off-targets, score, rank, fetch flank se-
102 quence and indicate whether the target and off-targets are located in exon region or not. Poten-
103 tial guide RNAs are annotated with total score of the top5 and topN off-targets, de-
104 tailed topN mismatch sites, restriction enzyme cut sites, and paired guide RNAs.
105
106 **Description**
107
108 Design of target-specific gRNAs for the CRISPR-Cas9 system by automatically finding potential
109 gRNAs (paired/not paired), with/without restriction enzyme cut site(s) in a given sequence, search-
110 ing for off targets with user defined maximum number of mismatches, calculating score of each
111 off target based on mismatch positions in the off target and a penalty weight matrix, filtering off
112 targets with user-defined criteria, and annotating off targets with flank sequences, whether located
113 in exon or not. Summary report is also generated with gRNAs ranked by total topN off target
114 score, annotated with restriction enzyme cut sites and possible paired gRNAs. Detailed paired gR-
115 NAs information and restriction enzyme cut sites are stored in separate files in the output directory
116 specified by the user. In total, four tab delimited files are generated in the output directory: Off-
117 targetAnalysis.xls (off target details), Summary.xls (gRNA summary), REcutDetails.xls (restriction
118 enzyme cut sites of each gRNA), and pairedgRNAs.xls (potential paired gRNAs).
119
120 **Author(s)**
121
122 Lihua Julie Zhu and Michael Brodsky Maintainer: julie.zhu@umassmed.edu
123
124 **Citation**
125
126 (from within R, enter citation("CRISPRseek")):
127
128 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/.
129
130 **References**
131
132 http://bioconductor.org/packages/2.8/bioc/vignettes/BSgenome/inst/doc/GenomeSearching.pdf
133
134 Patrick D Hsu, David A Scott, Joshua A Weinstein, F Ann Ran, Silvana Konermann, Vineeta Agar-
135 wala, Yinqing Li, Eli J Fine, Xuebing Wu, Ophir Shalem, Thomas J Cradick, Luciano A Marraffini,
136 Gang Bao, Feng Zhang (2013) DNA targeting specificity of rNA-guided Cas9 nucleases. Nature
137 Biotechnology 31:827-83
138
139 Mali P, Aach J, Stranges PB, Esvelt KM, Moosburner M, Kosuri S, Yang L, Church GM.CAS9
140 transcriptional activators for target specificity screening and paired nickases for cooperative genome
141 engineering. Nat Biotechnol. 2013. 31(9):833-8 Patrick D Hsu, David A Scott, Joshua A Wein-
142 stein, F Ann Ran, Silvana Konermann, Vineeta Agarwala, Yinqing Li, Eli J Fine, Xuebing Wu,
143 Ophir Shalem, Thomas J Cradick, Luciano A Marraffini, Gang Bao, Feng Zhang. DNA targeting
144 specificity of rNA-guided Cas9 nucleases. Nat Biotechnol. 2013. 31:827-834
145
146 **Reference Manual and Materials**
147
148 http://www.bioconductor.org/packages/release/bioc/vignettes/CRISPRseek/inst/doc/CRISPRseek.pdf
149
150 http://www.bioconductor.org/packages/release/bioc/manuals/CRISPRseek/man/CRISPRseek.pdf
151
152 http://www.bioconductor.org/packages/release/bioc/vignettes/CRISPRseek/inst/doc/CRISPRseek.R
153
154
155
156
157
158 </help>
159 <expand macro="citations" />
160
161 </tool>
162