0
|
1 <tool name="CollectGcBiasMetrics" id="picard_CollectGcBiasMetrics" version="1.122.0">
|
|
2 <description>charts the GC bias metrics</description>
|
|
3 <requirements>
|
|
4 <requirement type="package" version="1.122.0">picard</requirement>
|
|
5 </requirements>
|
|
6
|
|
7 <macros>
|
|
8 <import>picard_macros.xml</import>
|
|
9 </macros>
|
|
10
|
|
11 <command>
|
|
12 @java_options@
|
|
13 ##set up input files
|
|
14
|
|
15 #set $reference_fasta_filename = "localref.fa"
|
|
16
|
|
17 #if str( $reference_source.reference_source_selector ) == "history":
|
|
18 ln -s "${reference_source.ref_file}" "${reference_fasta_filename}" &&
|
|
19 #else:
|
|
20 #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path )
|
|
21 #end if
|
|
22
|
|
23 java -jar \$JAVA_JAR_PATH/CollectGcBiasMetrics.jar
|
|
24 INPUT="${inputFile}"
|
|
25 OUTPUT="${outFile}"
|
|
26 CHART_OUTPUT="${pdfFile}"
|
|
27 SUMMARY_OUTPUT="${summaryFile}"
|
|
28 WINDOW_SIZE="${window_size}"
|
|
29 MINIMUM_GENOME_FRACTION="${minimum_genome_fraction}"
|
|
30 IS_BISULFITE_SEQUENCED="${is_bisulfite_sequenced}"
|
|
31 REFERENCE_SEQUENCE="${reference_fasta_filename}"
|
|
32 ASSUME_SORTED="${assume_sorted}"
|
|
33
|
|
34 VALIDATION_STRINGENCY="${validation_stringency}"
|
|
35 QUIET=true
|
|
36 VERBOSITY=ERROR
|
|
37
|
|
38 </command>
|
|
39 <inputs>
|
|
40 <param format="sam,bam" name="inputFile" type="data" label="Select SAM/BAM dataset or dataset collection" help="If empty, upload or import a SAM/BAM dataset."/>
|
|
41 <conditional name="reference_source">
|
|
42 <param name="reference_source_selector" type="select" label="Load reference genome from">
|
|
43 <option value="cached">Local cache</option>
|
|
44 <option value="history">History</option>
|
|
45 </param>
|
|
46 <when value="cached">
|
|
47 <param name="ref_file" type="select" label="Using reference genome" help="REFERENCE_SEQUENCE">
|
|
48 <options from_data_table="all_fasta">
|
|
49 </options>
|
|
50 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
|
|
51 </param>
|
|
52 </when>
|
|
53 <when value="history">
|
|
54 <param name="ref_file" type="data" format="fasta" label="Use the folloing dataset as the reference sequence" help="REFERENCE_SEQUENCE; You can upload a FASTA sequence to the history and use it as reference" />
|
|
55 </when>
|
|
56 </conditional>
|
|
57 <param name="window_size" type="integer" value="100" label="The size of windows on the genome that are used to bin reads" help="WINDOW_SIZE; default=100"/>
|
|
58 <param name="minimum_genome_fraction" type="float" value="0.00005" label="For summary metrics, exclude GC windows that include less than this fraction of the genome" help="MINIMUM_GENOME_FRACTION; default=0.0005"/>
|
|
59 <param name="is_bisulfite_sequenced" type="boolean" label="Calculate the base distribution over PF (passing filtering) reads only" checked="true" truevalue="true" falsevalue="false" help="PF_READS_ONLY"/>
|
|
60 <param name="assume_sorted" type="boolean" label="Assume the input file is already sorted" checked="true" truevalue="true" falsevalue="false" help="ASSUME_SORTED"/>
|
|
61
|
|
62 <expand macro="VS" />
|
|
63
|
|
64 </inputs>
|
|
65
|
|
66 <outputs>
|
|
67 <data format="tabular" name="summaryFile" label="${tool.name} on ${on_string}: Summary stats"/>
|
|
68 <data format="tabular" name="outFile" label="${tool.name} on ${on_string}: Summary data"/>
|
|
69 <data format="pdf" name="pdfFile" label="${tool.name} on ${on_string}: Chart PDF"/>
|
|
70 </outputs>
|
|
71
|
|
72 <tests>
|
|
73 <test>
|
|
74 <param name="window_size" value="100" />
|
|
75 <param name="minimum_genome_fraction" value="0.00005" />
|
|
76 <param name="assume_sorted" value="true" />
|
|
77 <param name="is_bisulfite_sequenced" value="true" />
|
|
78 <param name="reference_source_selector" value="history" />
|
|
79 <param name="ref_file" value="picard_CollectGcBiasMetrics_ref.fa" />
|
|
80 <param name="inputFile" value="picard_CollectGcBiasMetrics.bam" ftype="bam" />
|
|
81 <output name="outFile" file="picard_CollectGcBiasMetrics_test1.tab" ftype="tabular" lines_diff="4"/>
|
|
82 </test>
|
|
83 </tests>
|
|
84
|
|
85 <stdio>
|
|
86 <exit_code range="1:" level="fatal"/>
|
|
87 </stdio>
|
|
88
|
|
89 <help>
|
|
90
|
|
91 .. class:: infomark
|
|
92
|
|
93 **Purpose**
|
|
94
|
|
95 Program to chart the nucleotide distribution per cycle in a SAM or BAM file.
|
|
96
|
|
97 @dataset_collections@
|
|
98
|
|
99 @description@
|
|
100
|
|
101 ALIGNED_READS_ONLY=Boolean If set to true, calculate the base distribution over aligned reads only. Default value:
|
|
102 false. Possible values: {true, false}
|
|
103
|
|
104 PF_READS_ONLY=Boolean If set to true calculate the base distribution over PF reads only. Default value: false.
|
|
105 This option can be set to 'null' to clear the default value. Possible values: {true,
|
|
106 false}
|
|
107
|
|
108 ASSUME_SORTED=Boolean
|
|
109 AS=Boolean If true (default), then the sort order in the header file will be ignored. Default: True
|
|
110
|
|
111 @more_info@
|
|
112
|
|
113 </help>
|
|
114 </tool>
|
|
115
|
|
116
|