annotate crispresso2.xml @ 2:eb5dbcfac76b draft default tip

Uploaded
author ieguinoa
date Thu, 05 May 2022 14:45:06 +0000
parents 3ed9b8271977
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
eb5dbcfac76b Uploaded
ieguinoa
parents: 1
diff changeset
1 <tool id="crispresso2" name="CRISPResso2" version="0.1.1" python_template_version="3.5">
0
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
2 <requirements>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
3 <requirement type="package" version="2.0.45">crispresso2</requirement>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
4 </requirements>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
5 <command detect_errors="exit_code"><![CDATA[
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
6 mkdir crispresso_out;
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
7 #if $singlePaired.fastq_r1.is_of_type('fastq.gz', 'fastqsanger.gz'):
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
8 #set $r1 = 'seq_name.fastq.gz'
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
9 #else:
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
10 #set $r1 = 'seq_name.fastq'
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
11 #end if
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
12 ln -s $singlePaired.fastq_r1 $r1;
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
13 mkdir -p '${html_file.files_path}' &&
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
14 #if str($singlePaired.sPaired) == 'paired':
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
15 #if $singlePaired.fastq_r2.is_of_type('fastq.gz', 'fastqsanger.gz'):
1
3ed9b8271977 Uploaded
ieguinoa
parents: 0
diff changeset
16 #set $r2 = 'seq_name2.fastq.gz'
0
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
17 #else:
1
3ed9b8271977 Uploaded
ieguinoa
parents: 0
diff changeset
18 #set $r2 = 'seq_name2.fastq'
0
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
19 #end if
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
20 ln -s $singlePaired.fastq_r2 $r2;
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
21 #end if
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
22 CRISPResso --fastq_r1 $r1
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
23 #if str($singlePaired.sPaired) == 'paired':
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
24 --fastq_r2 $r2
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
25 #end if
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
26 --amplicon_seq '$amplicon_seq'
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
27 -an '$amplicon_name'
1
3ed9b8271977 Uploaded
ieguinoa
parents: 0
diff changeset
28 -n reads
3ed9b8271977 Uploaded
ieguinoa
parents: 0
diff changeset
29 #if $sgrna_parameters.guide_seq:
3ed9b8271977 Uploaded
ieguinoa
parents: 0
diff changeset
30 --guide_seq $sgrna_parameters.guide_seq
3ed9b8271977 Uploaded
ieguinoa
parents: 0
diff changeset
31 #end if
0
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
32 #if $sgrna_parameters.guide_name:
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
33 --guide_name $sgrna_parameters.guide_name
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
34 #end if
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
35 #if $sgrna_parameters.flexiguide:
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
36 -fg $sgrna_parameters.flexiguide
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
37 #end if
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
38 #if $sgrna_parameters.flexiguide_homology:
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
39 --flexiguide_homology $sgrna_parameters.flexiguide_homology
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
40 #end if
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
41 #if $sgrna_parameters.flexiguide_name:
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
42 --flexiguide_name '$sgrna_parameters.flexiguide_name'
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
43 #end if
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
44 #if $coding_seq:
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
45 --coding_seq '$coding_seq'
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
46 #end if
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
47 $sgrna_parameters.discard_guide_positions_overhanging_amplicon_edge
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
48 $filtering_parameters.split_interleaved_input
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
49 #if $filtering_parameters.min_average_read_quality:
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
50 --min_average_read_quality $filtering_parameters.min_average_read_quality
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
51 #end if
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
52 #if $filtering_parameters.min_single_bp_quality:
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
53 --min_single_bp_quality $filtering_parameters.min_single_bp_quality
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
54 #end if
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
55 #if $filtering_parameters.min_bp_quality_or_N:
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
56 --min_bp_quality_or_N $filtering_parameters.min_bp_quality_or_N
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
57 #end if
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
58 #if $filtering_parameters.min_paired_end_reads_overlap:
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
59 --min_paired_end_reads_overlap $filtering_parameters.min_paired_end_reads_overlap
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
60 #end if
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
61 #if $filtering_parameters.max_paired_end_reads_overlap:
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
62 --max_paired_end_reads_overlap $filtering_parameters.max_paired_end_reads_overlap
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
63 #end if
2
eb5dbcfac76b Uploaded
ieguinoa
parents: 1
diff changeset
64 #if $window_parameters.cleavage_offset:
eb5dbcfac76b Uploaded
ieguinoa
parents: 1
diff changeset
65 --cleavage_offset '$window_parameters.cleavage_offset'
eb5dbcfac76b Uploaded
ieguinoa
parents: 1
diff changeset
66 #end if
eb5dbcfac76b Uploaded
ieguinoa
parents: 1
diff changeset
67 #if $output_parameters.suppress_report:
eb5dbcfac76b Uploaded
ieguinoa
parents: 1
diff changeset
68 --suppress_report
eb5dbcfac76b Uploaded
ieguinoa
parents: 1
diff changeset
69 #end if
0
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
70 $filtering_parameters.stringent_flash_merging
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
71 -o '${html_file.files_path}' > $output_log
1
3ed9b8271977 Uploaded
ieguinoa
parents: 0
diff changeset
72 && cp '${html_file.files_path}'/*\.html crispresso.html && cp '${html_file.files_path}'/CRISPResso_on_reads/CRISPResso_quantification_of_editing_frequency.txt $quant_editing_freq
0
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
73 ]]></command>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
74 <inputs>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
75 <conditional name="singlePaired">
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
76 <param name="sPaired" type="select" label="Single-end or paired-end reads">
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
77 <option value="single" selected="true">Single-end</option>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
78 <option value="paired">Paired-end</option>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
79 </param>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
80 <when value="single">
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
81 <param format="fastq,fastq.gz,fastqsanger.gz" name="fastq_r1" type="data" label="FASTQ file"/>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
82 </when>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
83 <when value="paired">
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
84 <param format="fastq,fastq.gz,fastqsanger.gz" name="fastq_r1" type="data" label="FASTQ file, forward reads"/>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
85 <param format="fastq,fastq.gz,fastqsanger.gz" name="fastq_r2" type="data" label="FASTQ file, reverse reads"/>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
86 </when>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
87 </conditional>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
88 <param name="amplicon_seq" type="text" label="Amplicon sequence" help="If submitting more than 1 amplicon, use commas to separate them"/>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
89 <param name="amplicon_name" type="text" label="Amplicon name" help="--amplicon_name"/>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
90 <param name="expected_hdr_amplicon_seq" type="text" label="Amplicon sequence expected after HDR" help="--expected_hdr_amplicon_seq"/>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
91 <param argument="--coding_seq" type="text" value="" label="Subsequence/s of the amplicon sequence covering one or more coding sequences for frameshift analysis" help="--coding_seq"/>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
92 <section name="sgrna_parameters" expanded="false" title="sgRNA parameters">
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
93 <param argument="--guide_name" type="text" label="sgRNA names" help="if more than one, please separate by commas. (default: sgRNA)"/>
1
3ed9b8271977 Uploaded
ieguinoa
parents: 0
diff changeset
94 <param argument="--guide_seq" type="text" value="" label="sgRNA sequence" help="sgRNA sequence, if more than one, please separate by commas"/>
3ed9b8271977 Uploaded
ieguinoa
parents: 0
diff changeset
95 <param argument="--flexiguide_name" type="text" value="" optional="True" label="Names for the flexiguides" help="Similar to --guide_name"/>
0
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
96 <param argument="--flexiguide" type="text" value="" label="sgRNA sequence (flexible)" help="The flexiguide sequence will be aligned to the amplicon sequence(s), as long as the guide sequence has homology as set by --flexiguide_homology"/>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
97 <param argument="--flexiguide_homology" type="integer" value="80" label="Flexiguide homology" help="will yield guides in amplicons with at least this homology to the flexiguide sequence (default:80 meaning 80% homology is required)"/>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
98 <param name="discard_guide_positions_overhanging_amplicon_edge" truevalue="" falsevalue="--discard_guide_positions_overhanging_amplicon_edge" type="boolean" default="False" label="Discard guide positions overhanging amplicon edge" help="If set, for guides that align to multiple positions, guide positions will be discarded if plotting around those regions would included bp that extend beyond the end of the amplicon"/>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
99 </section>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
100 <section name="filtering_parameters" expanded="false" title="Read filtering, trimming, and merging parameters">
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
101 <param name="split_interleaved_input" type="boolean" default="False" truevalue="--split_interleaved_input" falsevalue="" label="Splits a single fastq file containing paired end reads in two files before running CRISPResso"/>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
102 <param argument="--min_average_read_quality" value="0" type="integer" label="Minimum average quality score (phred33) to keep a read"/>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
103 <param argument="--min_single_bp_quality" type="integer" value="0" label="Minimum single bp score (phred33) to keep a read"/>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
104 <param argument="--min_bp_quality_or_N" type="integer" value="0" label="Bases with a quality score (phred33) less than this value will be set to 'N'"/>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
105 <param argument="--min_paired_end_reads_overlap" type="integer" value="10" label="Minimum overlap length between reads" help="Parameter for the FLASH read merging step. Minimum required overlap length between two reads to provide a confident overlap. (default: 10)" />
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
106 <param argument="--max_paired_end_reads_overlap" type="integer" value="100" label="Maximum overlap length between reads" help="Parameter for the FLASH merging step. Maximum overlap length expected in approximately 90% of read pairs. Please see the FLASH manual for more information. (default: 100)"/>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
107 <param name="stringent_flash_merging" truevalue="--stringent_flash_merging" falsevalue="" type="boolean" default="False" label="Use stringent parameters for flash merging" help="In the case where flash could merge R1 and R2 reads ambiguously, the expected overlap is calculated as 2*average_read_length - amplicon_length. The flash parameters for --min-overlap and --max-overlap will be set to prefer merged reads with length within 10bp of the expected overlap. These values override the --min_paired_end_reads_overlap or --max_paired_end_reads_overlap CRISPResso parameters"/>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
108 </section>
2
eb5dbcfac76b Uploaded
ieguinoa
parents: 1
diff changeset
109 <section name="window_parameters" expanded="false" title="Quantification window parameters">
eb5dbcfac76b Uploaded
ieguinoa
parents: 1
diff changeset
110 <param argument="cleavage_offset" type="integer" optional="True" default="-3" label="Center of quantification window to use within respect to the 3' end of the provided sgRNA sequence." help="-wc or --quantification_window_center or --cleavage_offset (default = -3)"/>
eb5dbcfac76b Uploaded
ieguinoa
parents: 1
diff changeset
111 </section>
eb5dbcfac76b Uploaded
ieguinoa
parents: 1
diff changeset
112 <section name="output_parameters" expanded="false" title="Output parameters">
eb5dbcfac76b Uploaded
ieguinoa
parents: 1
diff changeset
113 <param name="suppress_report" type="boolean" default="False" label="Suppress output report, plots output as .pdf only (not .png)" help="--suppress_report"/>
eb5dbcfac76b Uploaded
ieguinoa
parents: 1
diff changeset
114 </section>
0
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
115 </inputs>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
116 <outputs>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
117 <data format="txt" name="output_log" label="${tool.name} on ${on_string}: log" from_work_dir="Log.final.out"/>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
118 <data name="html_file" format="html" from_work_dir="crispresso.html" label="WebPage report"/>
1
3ed9b8271977 Uploaded
ieguinoa
parents: 0
diff changeset
119 <data format="txt" name="quant_editing_freq" label="CRISPResso_quantification_of_editing_frequency"/>
0
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
120 </outputs>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
121 <help><![CDATA[
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
122 TODO: Fill in help.
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
123 ]]></help>
a378f3ee0137 Uploaded
ieguinoa
parents:
diff changeset
124 </tool>