Mercurial > repos > iuc > multiqc

annotate template_plugin.xml @ 24:f7e2f1eb3a16 draft default tip

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/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
author iuc
date Mon, 02 Sep 2024 14:22:54 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
24
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
1 <macros>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
2 <!--
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
3 This is the TEMPLATE macro for MultiQC
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
4 1. please copy this template_plugin.xml to your own file e.g. trimmomatic_plugin.xml
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
5 2. Replace `TEMPLATE` with the name of the plugin, e.g. `fastqc`. The tokens and xml-names need to be called `trimmomatic_form` or `TRIMMOMATIC_COMMAND`
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
6 3. import your new *_plugin.xml macro into the main multiqc.xml file at the top of the file
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
7 4. add a new option to the main select element, e.g. `<option value="trimmomatic">Trimmomatic</option>`
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
8 5. add the *_COMMAND token to the <command> section.
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
9 6. add the *_test macro to the test section.
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
10 7. remove all unused comments from your new file
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
11 -->
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
12 <token name="@TEMPLATE_COMMAND@"><![CDATA[
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
13 <!--This pattern is used to check the file content in the @CHECK_LN_FILE@ token. The pattern should be included in the file. -->
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
14 #set $pattern = "Trimmomatic"
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
15 @LN_FILES@f
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
16 ]]></token>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
17 <xml name="TEMPLATE_form">
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
18 <!-- Please add here your input forms specific to your plugin. Keep the name as `input` if you have a single input.
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
19 If you have multiple inputs have a look at other plugins, e.g. fastqc
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
20 -->
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
21 <param name="input" type="data" format="txt,tabular,tsv,csv" multiple="true" label="Output of Trimmomatic" help="It should contain 'TTrimmomatic'"/>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
22 </xml>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
23 <!-- add here your test files and tests, the more stringent the better -->
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
24 <xml name="TEMPLATE_test">
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
25 <test expect_num_outputs="3">
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
26 <repeat name="results">
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
27 <conditional name="software_cond">
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
28 <param name="software" value="trimmomatic"/>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
29 <param name="input" value="trimmomatic.txt"/>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
30 </conditional>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
31 </repeat>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
32 <param name="title" value="Title of the report"/>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
33 <param name="comment" value="Commment for the report"/>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
34 <param name="flat" value="true"/>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
35 <param name="export" value="true"/>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
36 <output name="html_report">
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
37 <assert_contents>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
38 <has_text text="Title of the report"/>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
39 <has_text text="Commment for the report"/>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
40 <has_text text="cutadapt_trimmed_sequences_plot"/>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
41 <has_text text="All-in-one FASTQ preprocessor"/>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
42 <has_text text="trimmomatic_plot"/>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
43 </assert_contents>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
44 </output>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
45 <output name="stats">
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
46 <assert_contents>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
47 <has_text text="dataset_33"/>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
48 <has_text text="R1_fq"/>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
49 <has_text text="result_right"/>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
50 <has_text text="25839_merged"/>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
51 <has_text text="C2"/>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
52 <has_n_lines n="11"/>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
53 <has_n_columns n="22"/>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
54 </assert_contents>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
55 </output>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
56 <output_collection name="plots" type="list" count="29"/>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
57 </test>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
58 </xml>
f7e2f1eb3a16 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
iuc
parents:
diff changeset
59 </macros>