annotate macros.xml @ 4:993faa34333b draft

"planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 35da2dcd86747c9bff138e100dbe08c6106f3780"
author bgruening
date Sat, 06 Feb 2021 09:57:35 +0000
parents 52c01fb29b2a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
1 <macros>
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
2 <token name="@CP_VERSION@">3.1.9</token>
2
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
3 <token name="@PY_VERSION@">3.7</token>
0
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
4 <token name="@FORMATS@">jpg,png,tiff,bmp,gif,pcx,ppm,psd,pbm,pgm,eps</token>
2
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
5 <token name="@SPACES@">" "</token>
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
6 <!-- four spaces needed for CP pipeline file -->
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
7 <token name="@COMMON_HELP@">
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
8 .. class:: infomark
0
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
9
2
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
10 **Input**
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
11
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
12 Existing CellProfiler pipeline file *(.cppipe)* or generated by linking CellProfiler tools.
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
13
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
14 .. class:: infomark
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
15
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
16 **Output**
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
17
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
18 The input CellProfiler pipeline file *(.cppipe)* in addition to the settings of this module.
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
19
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
20 .. class:: warningmark
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
21
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
22 **IMPORTANT**
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
23
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
24 The first tool in a CellProfiler workflow has to be **Starting modules** and the last one **CellProfiler**. You can also execute the entire pipeline with the final CellProfiler tool, in which you feed in the images you want to process as well.
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
25 </token>
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
26
0
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
27
3
52c01fb29b2a "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit c3917e27eb1c1deeb381aa0dc8161c07699562fb"
bgruening
parents: 2
diff changeset
28 <xml name="output_pipeline_param">
52c01fb29b2a "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit c3917e27eb1c1deeb381aa0dc8161c07699562fb"
bgruening
parents: 2
diff changeset
29 <data name="output_pipeline" from_work_dir="output.cppipe" format="txt"/>
0
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
30 </xml>
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
31
2
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
32
3
52c01fb29b2a "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit c3917e27eb1c1deeb381aa0dc8161c07699562fb"
bgruening
parents: 2
diff changeset
33 <xml name="input_pipeline_param">
2
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
34 <param name="input_pipeline" type="data" format="data" label="Select the input CellProfiler pipeline"/>
0
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
35 </xml>
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
36
2
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
37
0
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
38 <xml name="cp_requirements">
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
39 <requirements>
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
40 <requirement type="package" version="@CP_VERSION@">cellprofiler</requirement>
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
41 </requirements>
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
42 </xml>
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
43
2
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
44
0
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
45 <xml name="py_requirements">
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
46 <requirements>
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
47 <requirement type="package" version="@PY_VERSION@">python</requirement>
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
48 </requirements>
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
49 </xml>
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
50
2
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
51
0
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
52 <xml name="citations">
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
53 <citations>
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
54 <citation type="bibtex">
2
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
55 @article{McQuin_2018,
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
56 title = {CellProfiler 3.0: Next-generation image processing for biology},
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
57 author = {McQuin C, Goodman A, Chernyshev V, Kamentsky L, Cimini BA, Karhohs KW, Doan M, Ding L, Rafelski SM, Thirstrup D, Wiegraebe W, Singh S, Becker T, Caicedo JC, Carpenter AE},
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
58 year = {2018},
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
59 volume = {16(7):e2005970},
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
60 DOI = {10.1371/journal.pbio.2005970},
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
61 journal = {PLoS Biol.},
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
62 url = {https://journals.plos.org/plosbiology/article?id=10.1371/journal.pbio.2005970},
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
63 }
0
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
64 </citation>
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
65 </citations>
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
66 </xml>
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
67
2
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
68
0
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
69 <xml name="cmd_modules">
2
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
70 <command detect_errors="aggressive">
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
71 <![CDATA[
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
72 python '$script_file' '$inputs' '$input_pipeline'
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
73 ]]>
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
74 </command>
0
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
75 </xml>
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
76
2
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
77
0
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
78 <xml name="text_validator">
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
79 <validator type="regex" message="Only numbers, letters, hyphen, underscore and spaces are allowed">^[A-Za-z0-9 _-]*$</validator>
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
80 </xml>
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
81
2
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
82
0
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
83 <xml name="test_input_pipeline_param">
3
52c01fb29b2a "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit c3917e27eb1c1deeb381aa0dc8161c07699562fb"
bgruening
parents: 2
diff changeset
84 <param name="input_pipeline" value="common.cppipe" />
0
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
85 </xml>
2
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
86
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
87
3
52c01fb29b2a "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit c3917e27eb1c1deeb381aa0dc8161c07699562fb"
bgruening
parents: 2
diff changeset
88 <xml name="test_out_file" token_file="common.cppipe">
52c01fb29b2a "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit c3917e27eb1c1deeb381aa0dc8161c07699562fb"
bgruening
parents: 2
diff changeset
89 <output name="output_pipeline" ftype="txt" file="@FILE@" lines_diff="0"/>
2
d9bf32d13dfd "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 1907942bef43b20edfdbd1d1b5eb1cac3602848b"
bgruening
parents: 0
diff changeset
90 </xml>
3
52c01fb29b2a "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit c3917e27eb1c1deeb381aa0dc8161c07699562fb"
bgruening
parents: 2
diff changeset
91
0
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
92 </macros>
99e493b2e951 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools commit 6d73056a625002d0275b5a9a90a9fae329ce47f1"
bgruening
parents:
diff changeset
93