annotate garnett_train_classifier.xml @ 2:e7bb0bf34f26 draft

"planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 85476ee7f3b1d96e9d0afb972af1aaa67d990ce4"
author ebi-gxa
date Mon, 27 Apr 2020 11:19:44 -0400
parents 2067ebe66b55
children 9be21507358d
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[
1
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
8 garnett_train_classifier.R --cds-object '${cds_object}' --marker-file-path '${marker_file_path}' --database '${database}' --cores \${GALAXY_SLOTS:-1} --output-path '${output_classifier_path}'
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
9 #if $train_id
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
10 --train-id '${train_id}'
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
11 #end if
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
12 #if $cds_gene_id_type
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
13 --cds-gene-id-type '${cds_gene_id_type}'
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
14 #end if
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
15 #if $marker_file_gene_id_type
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
16 --marker-file-gene-id-type '${marker_file_gene_id_type}'
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
17 #end if
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
18 #if $num_unknown
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
19 --num-unknown '${num_unknown}'
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
20 #end if
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
21 #if $min_observations
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
22 --min-observations '${min_observations}'
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
23 #end if
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
24 #if $max_training_samples
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
25 --max-training-samples '${max_training_samples}'
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
26 #end if
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
27 #if $propogate_markers
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
28 --propogate-markers '${propogate_markers}'
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
29 #end if
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
30 #if $classifier_gene_id_type
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
31 --classifier-gene-id-type '${classifier_gene_id_type}'
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
32 #end if
0
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
33 ]]></command>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
34 <inputs>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
35 <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
36 <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
37 See https://cole-trapnell-lab.github.io/garnett/docs/#constructing-a-marker-file for specification of the file format" />
1
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
38 <param type="text" name="train_id" label="Dataset ID" help="ID of the training dataset" />
0
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
39 <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
40 <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
41 <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
42 <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
43 <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
44 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
45 <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
46 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
47 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
48 <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
49 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
50 <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
51 </inputs>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
52 <outputs>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
53 <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
54 </outputs>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
55 <tests>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
56 <test>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
57 <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
58 <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
59 <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
60 </test>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
61 </tests>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
62 <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
63 @HELP@
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
64
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
65 @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
66 ]]></help>
24a22971dd44 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 4c3dfa7bbd82d702e7e8187c7556f3289804cb49"
ebi-gxa
parents:
diff changeset
67 <expand macro="citations" />
1
2067ebe66b55 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 241c850301f8094f6aa0016e2335a8b550c29aed"
ebi-gxa
parents: 0
diff changeset
68 </tool>