Mercurial > repos > iuc > qiime_validate_mapping_file

annotate validate_mapping_file.xml @ 0:e314b009545d draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
author iuc
date Thu, 18 May 2017 09:12:39 -0400
parents
children bdf07e6d0108
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
1 <tool id="qiime_validate_mapping_file" name="Validate mapping file" version="@WRAPPER_VERSION@.0">
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
2 <description>to check for required data and format</description>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
3 <macros>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
4 <import>macros.xml</import>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
5 </macros>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
6 <expand macro="requirements"/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
7 <version_command>validate_mapping_file.py --version</version_command>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
8 <command detect_errors="aggressive"><![CDATA[
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
9 validate_mapping_file.py
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
10 --mapping_fp '$mapping_fp'
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
11 -o validate_mapping_file_output
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
12 $verbose
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
13 --char_replace '$char_replace'
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
14 $not_barcoded
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
15 $variable_len_barcodes
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
16 $disable_primer_check
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
17 #if str($added_demultiplex_field):
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
18 --added_demultiplex_field '$added_demultiplex_field'
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
19 #end if
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
20 $suppress_html
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
21
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
22 #if not $suppress_html:
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
23 && mkdir -p '$html_report.files_path'
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
24 && mv validate_mapping_file_output/*.html '$html_report'
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
25 && cp validate_mapping_file_output/overlib.js '$html_report.files_path'
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
26 #end if
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
27 ]]></command>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
28 <inputs>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
29 <param argument="--mapping_fp" label="Metadata mapping filepath" type="data" format="tabular,csv,txt" help=""/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
30 <param argument="--verbose" type="boolean" label="Enable printing information to standard out?" truevalue="-v" falsevalue="" checked="False"/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
31 <param argument="--char_replace" type="text" value="_" label="Default character used to replace invalid characters found in the mapping file" help="Must be a valid character (alphanumeric, period, or underscore)"/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
32 <param argument="--not_barcoded" type="boolean" label="Are barcodes present?" truevalue="" falsevalue="--not_barcoded" checked="True" help="BarcodeSequence header is still required in mapping file"/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
33 <param argument="--variable_len_barcodes" type="boolean" label="Are barcodes with variable length?" truevalue="" falsevalue="--variable_len_barcodes" checked="True" help=""/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
34 <param argument="--disable_primer_check" type="boolean" label="Disable checks for primers?" truevalue="-disable_primer_check" falsevalue="" checked="False" help="LinkerPrimerSequence header is still required in mapping file"/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
35 <param argument="--added_demultiplex_field" type="text" label="Field to use in the mapping file as additional demultiplexing (optional)" help="It can be used with or without barcodes. All combinations of barcodes/primers and these fields must be unique. The fields must contain values that can be parsed from the fasta labels such as 'plate=R_2008_12_09'. In this case, 'plate' would be the column header and 'R_2008_12_09' would be the field data (minus quotes) in the mapping file. To use the run prefix from the fasta label, such as 'FLP3FBN01ELBSX', where 'FLP3FBN01' is generated from the run ID, use 'run_prefix' and set the run prefix to be used as the data under the column header 'run_prefix'" optional="True"/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
36 <param argument="--suppress_html" type="boolean" label="Disable html file generation?" truevalue="-s" falsevalue="" checked="False" help="It can be useful for extremely large mapping files"/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
37 </inputs>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
38 <outputs>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
39 <data name="html_report" format="html" label="${tool.name} on ${on_string}: html report">
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
40 <filter>suppress_html is False</filter>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
41 </data>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
42 <data name="log" format="txt" from_work_dir="validate_mapping_file_output/*.log" label="${tool.name} on ${on_string}: log"/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
43 <data format="tabular" name="mapping_fp_corrected" from_work_dir="validate_mapping_file_output/*corrected.txt" label="${tool.name} on ${on_string}: corrected map"/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
44 </outputs>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
45 <tests>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
46 <test>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
47 <param name="mapping_fp" value="validate_mapping_file/map.tsv"/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
48 <param name="verbose" value=""/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
49 <param name="char_replace" value="_"/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
50 <param name="not_barcoded" value=""/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
51 <param name="variable_len_barcodes" value=""/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
52 <param name="disable_primer_check" value=""/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
53 <param name="suppress_html" value=""/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
54 <output name="log" file="validate_mapping_file/log.txt"/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
55 <output name="mapping_fp_corrected" file="validate_mapping_file/corrected_map.tabular"/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
56 </test>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
57 </tests>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
58 <help><![CDATA[
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
59 **What it does**
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
60
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
61 This tool checks user’s metadata mapping file for required data, valid format
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
62
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
63 Specifically, it checks that:
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
64
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
65 - The BarcodeSequence, LinkerPrimerSequences, and ReversePrimer fields have valid IUPAC DNA characters, and BarcodeSequence characters are non-degenerate (error)
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
66 - The SampleID, BarcodeSequence, LinkerPrimerSequence, and Description headers are present. (error)
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
67 - There are not duplicate header fields (error)
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
68 - There are not duplicate barcodes (error)
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
69 - Barcodes are of the same length. Suppressed when variable_len_barcode flag is passed (warning)
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
70 - The headers do not contain invalid characters (alphanumeric and underscore only) (warning)
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
71 - The data fields do not contain invalid characters (alphanumeric, underscore, space, and +-%./:,; characters) (warning)
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
72 - SampleID fields are MIENS compliant (only alphanumeric and . characters). (warning)
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
73 - There are no duplicates when the primer and variable length barcodes are appended (error)
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
74 - There are no duplicates when barcodes and added demultiplex fields (-j option) are combined (error)
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
75 - Data fields are not found beyond the Description column (warning)
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
76
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
77 More information about this tool is available on
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
78 `QIIME documentation <http://qiime.org/scripts/validate_mapping_file.html>`_.
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
79 ]]></help>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
80 <citations>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
81 <expand macro="citations"/>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
82 </citations>
e314b009545d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiime/ commit c9bf747b23b4a9d6adc20c7740b9247c22654862
iuc
parents:
diff changeset
83 </tool>