Mercurial > repos > devteam > picard
annotate picard_CollectAlignmentSummaryMetrics.xml @ 13:7e6fd3d0f16e draft
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
| author | devteam |
|---|---|
| date | Tue, 06 Dec 2016 10:04:41 -0500 |
| parents | 05087b27692a |
| children | 465cbb0cf2eb |
| rev | line source |
|---|---|
|
10
777ccdd1d6e4
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
9
diff
changeset
|
1 <tool name="Collect Alignment Summary Metrics" id="picard_CASM" version="@TOOL_VERSION@.1"> |
| 5 | 2 <description>writes a file containing summary alignment metrics</description> |
| 3 <macros> | |
| 4 <import>picard_macros.xml</import> | |
| 5 </macros> | |
|
8
3a3234d7a2e8
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
5
diff
changeset
|
6 <expand macro="requirements" /> |
|
12
05087b27692a
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents:
10
diff
changeset
|
7 <command detect_errors="exit_code"><![CDATA[ |
| 5 | 8 @java_options@ |
|
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
9 @symlink_element_identifier@ |
| 5 | 10 ##set up input files |
| 11 | |
| 12 #set $reference_fasta_filename = "localref.fa" | |
|
10
777ccdd1d6e4
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
9
diff
changeset
|
13 |
| 5 | 14 #if str( $reference_source.reference_source_selector ) == "history": |
|
12
05087b27692a
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents:
10
diff
changeset
|
15 ln -s "${reference_source.ref_file}" "${reference_fasta_filename}" && |
| 5 | 16 #else: |
| 17 #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path ) | |
| 18 #end if | |
|
10
777ccdd1d6e4
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
9
diff
changeset
|
19 |
|
12
05087b27692a
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents:
10
diff
changeset
|
20 picard |
| 5 | 21 CollectAlignmentSummaryMetrics |
|
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
22 INPUT='$inputFile.element_identifier' |
| 5 | 23 OUTPUT="${outFile}" |
| 24 MAX_INSERT_SIZE=${maxinsert} | |
| 25 #for $sequence in $adapters: | |
| 26 ADAPTER_SEQUENCE="${sequence.adapter}" | |
| 27 #end for | |
|
10
777ccdd1d6e4
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
9
diff
changeset
|
28 #for $level in str($metric_accumulation_level).split(','): |
|
777ccdd1d6e4
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
9
diff
changeset
|
29 METRIC_ACCUMULATION_LEVEL="${level}" |
|
777ccdd1d6e4
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
9
diff
changeset
|
30 #end for |
| 5 | 31 IS_BISULFITE_SEQUENCED="${bisulphite}" |
|
10
777ccdd1d6e4
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
9
diff
changeset
|
32 |
| 5 | 33 REFERENCE_SEQUENCE="${reference_fasta_filename}" |
|
10
777ccdd1d6e4
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
9
diff
changeset
|
34 |
| 5 | 35 ASSUME_SORTED="${assume_sorted}" |
| 36 | |
| 37 VALIDATION_STRINGENCY="${validation_stringency}" | |
| 38 QUIET=true | |
| 39 VERBOSITY=ERROR | |
|
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
40 |
|
12
05087b27692a
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents:
10
diff
changeset
|
41 ]]></command> |
| 5 | 42 <inputs> |
| 43 <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."/> | |
| 44 <conditional name="reference_source"> | |
| 45 <param name="reference_source_selector" type="select" label="Load reference genome from"> | |
| 46 <option value="cached">Local cache</option> | |
| 47 <option value="history">History</option> | |
| 48 </param> | |
| 49 <when value="cached"> | |
| 50 <param name="ref_file" type="select" label="Using reference genome" help="REFERENCE_SEQUENCE"> | |
| 51 <options from_data_table="all_fasta"> | |
| 52 </options> | |
| 53 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/> | |
| 54 </param> | |
| 55 </when> | |
| 56 <when value="history"> | |
|
8
3a3234d7a2e8
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
5
diff
changeset
|
57 <param name="ref_file" type="data" format="fasta" label="Use the following dataset as the reference sequence" help="REFERENCE_SEQUENCE; You can upload a FASTA sequence to the history and use it as reference" /> |
| 5 | 58 </when> |
| 59 </conditional> | |
| 60 <param name="metric_accumulation_level" type="select" label="The level(s) at which to accumulate metrics" multiple="true" help="METRIC_ACCUMULATION_LEVEL"> | |
| 61 <option value="ALL_READS" selected="True">All reads</option> | |
| 62 <option value="SAMPLE">Sample</option> | |
| 63 <option value="LIBRARY">Library</option> | |
| 64 <option value="READ_GROUP">Read group</option> | |
| 65 </param> | |
| 66 <param name="assume_sorted" type="boolean" label="Assume the input file is already sorted" checked="true" truevalue="true" falsevalue="false" help="ASSUME_SORTED"/> | |
| 67 <param name="bisulphite" type="boolean" label="Input file contains Bisulphite sequenced reads" checked="false" falsevalue="false" truevalue="true" help="IS_BISULFITE_SEQUENCED"/> | |
| 68 <repeat name="adapters" title="Adapter" min="0" help="You can provide multiple adaptor sequences"> | |
|
9
5eaa8a968300
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 1869970193a1878acbc0f8a79b81dd02b37f1dc1
devteam
parents:
8
diff
changeset
|
69 <param name="adapter" type="text" label="Use this adaptor sequence" help="ADAPTER_SEQUENCE"/> |
| 5 | 70 </repeat> |
|
9
5eaa8a968300
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 1869970193a1878acbc0f8a79b81dd02b37f1dc1
devteam
parents:
8
diff
changeset
|
71 <param name="maxinsert" value="100000" type="integer" label="Larger paired end reads and inter-chromosomal pairs considered chimeric" help="MAX_INSERT_SIZE"/> |
| 5 | 72 <expand macro="VS" /> |
|
10
777ccdd1d6e4
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
9
diff
changeset
|
73 |
| 5 | 74 </inputs> |
| 75 <outputs> | |
| 76 <data format="tabular" name="outFile" label="${tool.name} on ${on_string}: Summary stats"/> | |
| 77 </outputs> | |
| 78 <tests> | |
| 79 <test> | |
| 80 <param name="bisulphite" value="false" /> | |
| 81 <param name="sorted" value="true" /> | |
| 82 <param name="adaptors" value="" /> | |
| 83 <param name="maxinsert" value="100000" /> | |
| 84 <param name="reference_source_selector" value="history" /> | |
| 85 <param name="ref_file" value="picard_CASM_ref.fa" /> | |
| 86 <param name="inputFile" value="picard_CASM.bam" ftype="bam" /> | |
| 87 <output name="outFile" file="picard_CASM_test1.tab" ftype="tabular" lines_diff="4"/> | |
| 88 </test> | |
| 89 </tests> | |
| 90 <help> | |
| 91 | |
| 92 .. class:: infomark | |
| 93 | |
| 94 **Purpose** | |
| 95 | |
| 96 Reads a SAM or BAM file and writes a file containing summary alignment metrics. | |
| 97 | |
| 98 @dataset_collections@ | |
| 99 | |
| 100 @description@ | |
| 101 | |
|
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
102 MAX_INSERT_SIZE=Integer Paired end reads above this insert size will be considered chimeric along with |
|
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
103 inter-chromosomal pairs. Default value: 100000. |
| 5 | 104 |
|
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
105 ADAPTER_SEQUENCE=String List of adapter sequences to use when processing the alignment metrics This option may |
|
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
106 be specified 0 or more times. |
| 5 | 107 |
| 108 METRIC_ACCUMULATION_LEVEL=MetricAccumulationLevel | |
|
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
109 LEVEL=MetricAccumulationLevel The level(s) at which to accumulate metrics. Possible values: {ALL_READS, SAMPLE, |
|
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
110 LIBRARY, READ_GROUP} This option may be specified 0 or more times. |
| 5 | 111 |
| 112 IS_BISULFITE_SEQUENCED=Boolean | |
|
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
113 BS=Boolean Whether the SAM or BAM file consists of bisulfite sequenced reads. |
| 5 | 114 |
| 115 | |
| 116 REFERENCE_SEQUENCE=File | |
|
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
117 R=File Reference sequence fasta Default value: null. |
| 5 | 118 |
| 119 ASSUME_SORTED=Boolean | |
|
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
120 AS=Boolean If true (default), then the sort order in the header file will be ignored. |
| 5 | 121 |
| 122 @more_info@ | |
| 123 | |
| 124 </help> | |
| 125 </tool> | |
| 126 | |
| 127 |