annotate scater-is-outlier.xml @ 0:add247843ef0 draft default tip

planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
author ebi-gxa
date Wed, 03 Apr 2019 11:42:39 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
1 <tool id="scater_is_outlier" name="Scater DetectOutlier" version="@TOOL_VERSION@+galaxy0">
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
2 <description>cells based on expression metrics</description>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
3 <macros>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
4 <import>scater_macros.xml</import>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
5 </macros>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
6 <expand macro="requirements" />
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
8 scater-extract-qc-metric.R -i '${R_scater_qc}' -m '$metrics' -o metrics.csv &&
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
9
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
10 scater-is-outlier.R -m metrics.csv
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
11 #if $nmads:
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
12 -n '$nmads'
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
13 #end if
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
14 #if $outlier_type:
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
15 -t '$outlier_type'
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
16 #end if
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
17 #if $outlier_log:
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
18 -l '$outlier_log'
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
19 #end if
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
20 #if $outlier_min_diff:
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
21 -d '$outlier_min_diff'
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
22 #end if
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
23 -o outliers.txt &&
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
24
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
25 cut -f1 -d',' outliers.txt > '$outliers_file'
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
26 ]]></command>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
27
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
28 <inputs>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
29 <param name="R_scater_qc" type="data" format="rdata" label="Input serialized SingleCellExperiment RDS object"
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
30 help="A serialized SingleCellExperiment RDS object with pre-calculated QC metrics"/>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
31
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
32 <param name="metrics" type="text" label="Name of the QC metric used to detected outlier"
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
33 help ="character scalar, name of a numeric QC metric available in the input SingleCellExperiment object."/>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
34
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
35 <param name="outlier_type" argument="--type" type="select" value="both" label="Detect outlier from lower/higher/both ends of the distribution"
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
36 help="character scalar, choice indicate whether outliers should be looked for at both tails (default: both) or only at the lower end (lower) or the higher end (higher).">
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
37 <option value="both">Both</option>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
38 <option value="lower">Lower</option>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
39 <option value="higher">Higher</option>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
40 </param>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
41
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
42 <param name="outlier_log" argument="--log" type="boolean" checked="false" label="Transform to log10 scale"
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
43 help="logical, should the values of the metric be transformed to the log10 scale before computing median-absolute-deviation for outlier detection"/>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
44
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
45 <param name="nmads" argument="--nmads" type="integer" optional="true" value="5" label="Threshold in number of MAD away from the median"
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
46 help="scalar, number of median-absolute-deviations away from median required for a value to be called an outlier."/>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
47
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
48 <param name="outlier_min_diff" argument="--min-diff" type="integer" optional="true" label="Threshold in value difference from the median"
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
49 help="numeric scalar indicating the minimum difference from the median to consider as an outlier. The outlier threshold is defined from the larger of nmads MADs and min.diff, to avoid calling many outliers when the MAD is very small. If NA, it is ignored."/>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
50 </inputs>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
51
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
52 <outputs>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
53 <data name="outliers_file" format="csv" label="${tool.name} on ${on_string}: a one column csv of outliers"/>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
54 </outputs>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
55
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
56 <tests>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
57 <test>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
58 <param name="extracted_metrics_file" value="extracted_metrics_file.txt"/>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
59 <output name="outliers_file" file="outliers_file.txt"/>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
60 </test>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
61 </tests>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
62
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
63 <help><![CDATA[
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
64 @HELP@
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
65
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
66 @VERSION_HISTORY@
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
67 ]]></help>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
68 <expand macro="citations"/>
add247843ef0 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
69 </tool>