annotate garnett_train_classifier.xml @ 0:24a22971dd44 draft

"planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
author ebi-gxa
date Wed, 08 Apr 2020 06:28:28 -0400
parents
children 2067ebe66b55
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
1 <tool id="garnett_train_classifier" name="Garnett - train classifier" version="@TOOL_VERSION@+galaxy0" profile="@PROFILE@">
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
2 <description>Train classifier based on marker gene list</description>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
3 <macros>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
4 <import>garnett_macros.xml</import>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
5 </macros>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
6 <expand macro="requirements" />
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
8 garnett_train_classifier.R --cds-object '${cds_object}' --marker-file-path '${marker_file_path}' --database '${database}' --cds-gene-id-type '${cds_gene_id_type}' --marker-file-gene-id-type '${marker_file_gene_id_type}' --num-unknown '${num_unknown}' --min-observations '${min_observations}' --max-training-samples '${max_training_samples}' --propogate-markers '${propogate_markers}' --cores '${cores}' --classifier-gene-id-type '${classifier_gene_id_type}' --output-path '${output_classifier_path}'
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
9 ]]></command>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
10 <inputs>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
11 <param type="data" name="cds_object" label="CDS object" format="rdata" help="CDS object with expression data for training" />
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
12 <param type="data" name="marker_file_path" format="txt" label="Marker file path" help="File with marker genes specifying cell types.
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
13 See https://cole-trapnell-lab.github.io/garnett/docs/#constructing-a-marker-file for specification of the file format" />
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
14 <param type="text" name="database" label="gene database" value="org.Hs.eg.db" help="argument for Bioconductor AnnotationDb-class package used for converting gene IDs" />
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
15 <param type="text" name="cds_gene_id_type" label="CDS gene id type" value="ENSEMBL" help="Format of the gene IDs in your CDS object" />
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
16 <param type="text" name="marker_file_gene_id_type" label="Marker gene id type" value="ENSEMBL" help="Format of the gene IDs in your marker file" />
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
17 <param type="integer" name="num_unknown" value='500' label="number of outputs" help="Number of outgroups to compare against" />
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
18 <param type="integer" name="min_observations" value='8' label="Min num of observations" help="The minimum number of representative cells per
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
19 cell type required to include the cell type in the predictive model" />
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
20 <param type="integer" name="max_training_samples" value='500' label="Max num of training samples" help="The maximum number of representative cells per cell
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
21 type to be included in the model training. Decreasing this number
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
22 increases speed, but may hurt performance of the model." />
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
23 <param type="boolean" name="propogate_markers" checked="true" label="propogate markers" help="Should markers from child nodes of a cell type be used
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
24 in finding representatives of the parent type?" />
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
25 <param type="integer" name="cores" label="cores" value="1" help="The number of cores to use for computation" />
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
26 <param type="text" name="classifier_gene_id_type" label="Classifier gene ID type" value="ENSEMBL" help="The type of gene ID that will be used in the classifier. If possible for your organism, this should be 'ENSEMBL', which is the default." />
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
27 </inputs>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
28 <outputs>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
29 <data name="output_classifier_path" format="rdata" />
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
30 </outputs>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
31 <tests>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
32 <test>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
33 <param name="cds_object" value="garnett_cds.rds" />
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
34 <param name="marker_file_path" value="markers_upd.txt" />
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
35 <output name="output_classifier_path" value="trained_classifier.rds" />
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
36 </test>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
37 </tests>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
38 <help><![CDATA[
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
39 @HELP@
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
40
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
41 @VERSION_HISTORY@
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
42 ]]></help>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
43 <expand macro="citations" />
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
44 </tool>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
45
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
46