Skip to content

Commit

Permalink
Add simple help for apply rules tool.
Browse files Browse the repository at this point in the history
  • Loading branch information
jmchilton committed Apr 24, 2018
1 parent 8af243c commit c225c5d
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions lib/galaxy/tools/apply_rules.xml
Expand Up @@ -13,4 +13,24 @@
<collection name="output" format_source="input" type_from_rules="rules" label="${on_string} (re-organized)" >
</collection>
</outputs>
<help><![CDATA[
This tool allows one to process an existing Galaxy dataset collection's metadata as tabular data,
apply a series of rules to it, and generate a new collection. When used interactively in the tool
form, a dynamic preview of the processing will be available in a tabular data viewer but this tool
may be used in workflows as well where no such preview can be generated.
This tool is an advanced feature but has a lot of flexibility - it can be used to process collections
with arbitrary nesting and can do many be used to do many kinds of filtering, re-sorting, nesting,
flattening, and arbitrary combinations thereof not possible with Galaxy's other, more simple
collection operation tools.
More information about the rule processor in general can be found `here
<https://github.com/jmchilton/training-material/blob/rules/topics/introduction/tutorials/galaxy-intro-rules/tutorial.md>`__ (this link is to documentation that is pretty rough still).
.. class:: infomark
This tool will create new history datasets from your collection but your quota usage will not increase.
]]></help>
</tool>

0 comments on commit c225c5d

Please sign in to comment.