|
| 1 | +<tool id="__FILTER_FAILED_DATASETS__" |
| 2 | + name="Filter failed datasets" |
| 3 | + version="1.1.0" |
| 4 | + tool_type="filter_failed_datasets_collection"> |
| 5 | + <description></description> |
| 6 | + <type class="FilterFailedDatasetsTool" module="galaxy.tools" /> |
| 7 | + <action module="galaxy.tools.actions.model_operations" |
| 8 | + class="ModelOperationToolAction"/> |
| 9 | + <edam_operations> |
| 10 | + <edam_operation>operation_3695</edam_operation> |
| 11 | + </edam_operations> |
| 12 | + <inputs> |
| 13 | + <param type="data_collection" collection_type="list,list:paired" name="input" label="Input Collection" /> |
| 14 | + <param type="data" name="replacement" optional="true" label="Replace failed elements with this dataset" help="If provided, failed elements will be replaced with this dataset"/> |
| 15 | + </inputs> |
| 16 | + <outputs> |
| 17 | + <collection name="output" format_source="input" type_source="input" label="${on_string} (filtered failed datasets)" > |
| 18 | + </collection> |
| 19 | + </outputs> |
| 20 | + <tests> |
| 21 | + <!-- Test framework has no way of creating a collection with |
| 22 | + failed elements, so best we can do is verify identity on |
| 23 | + an okay collection. API tests verify this tool works |
| 24 | + though. |
| 25 | + --> |
| 26 | + <test> |
| 27 | + <param name="input"> |
| 28 | + <collection type="list"> |
| 29 | + <element name="e1" value="simple_line.txt" /> |
| 30 | + </collection> |
| 31 | + </param> |
| 32 | + <output_collection name="output" type="list"> |
| 33 | + <element name="e1"> |
| 34 | + <assert_contents> |
| 35 | + <has_text_matching expression="^This is a line of text.\n$" /> |
| 36 | + </assert_contents> |
| 37 | + </element> |
| 38 | + </output_collection> |
| 39 | + </test> |
| 40 | + </tests> |
| 41 | + <help><![CDATA[ |
| 42 | +
|
| 43 | +======== |
| 44 | +Synopsis |
| 45 | +======== |
| 46 | +
|
| 47 | +Removes datasets in error (red) from a collection. |
| 48 | +
|
| 49 | +=========== |
| 50 | +Description |
| 51 | +=========== |
| 52 | +
|
| 53 | +This tool takes a dataset collection and filters out (removes) datasets in the failed (red) state. This is useful for continuing a multi-sample analysis when one or more of the samples fails at some point. |
| 54 | +
|
| 55 | +.. image:: ${static_path}/images/tools/collection_ops/filter_error.svg |
| 56 | + :width: 500 |
| 57 | + :alt: Filter failed datasets |
| 58 | +
|
| 59 | +----- |
| 60 | +
|
| 61 | +.. class:: infomark |
| 62 | +
|
| 63 | +This tool will create new history datasets from your collection but your quota usage will not increase. |
| 64 | +
|
| 65 | + ]]></help> |
| 66 | +</tool> |
0 commit comments