annotate mergeMutationDatasets.xml @ 40:72dc9215623d

modify help
author jingchunzhu
date Fri, 31 Jul 2015 21:29:17 -0700
parents 3a259686f0fc
children 9806198df91f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
21
3a259686f0fc Merged with head, tweaked labels on merge mutation data tool
melissacline
parents: 20
diff changeset
1 <tool id="mergeMutationDatasets" description="Merge two Xena positional mutation datasets into a new dataset" name="Merge Positional Mutation Data" version="0.0.1">
19
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
2 <description>
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
3 Given two mutation datasets, merge them to create a larger dataset with the mutations from both datasets. Output this larger dataset, along with a 2-column matrix indicating the source of each mutation
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
4 </description>
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
5 <command interpreter="python">
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
6 mergeXenaMutation.py $outputC $outputSourceMatrix $errorLog $inputA $inputB
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
7 #if $labelForDatasetA
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
8 --aLabel "${labelForDatasetA}"
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
9 #end if
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
10 #if $labelForDatasetB
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
11 --bLabel "${labelForDatasetB}"
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
12 #end if
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
13 </command>
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
14 <inputs>
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
15 <param name="inputA" format="tabular" type="data" label="Mutation Dataset A"/>
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
16 <param type="text" name="labelForDatasetA" label="Dataset A Label (optional)" optional="true"/>
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
17 <param name="inputB" format="tabular" type="data" label="Mutation Dataset B"/>
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
18 <param type="text" name="labelForDatasetB" label="Dataset B Label (optional)" optional="true"/>
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
19 </inputs>
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
20 <outputs>
20
914bc8ee6222 Debugged the merge mutation data tool
melissacline
parents: 19
diff changeset
21 <data name="errorLog" format="data" label="Execution Log"/>
19
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
22 <data name="outputSourceMatrix" format="tabular" label="Mutation Data Sources"/>
20
914bc8ee6222 Debugged the merge mutation data tool
melissacline
parents: 19
diff changeset
23 <data name="outputC" format="tabular" label="Merged Mutation Data"/>
19
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
24 </outputs>
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
25 <help>
21
3a259686f0fc Merged with head, tweaked labels on merge mutation data tool
melissacline
parents: 20
diff changeset
26 ***Merge Xena Positional Mutation Datasets***
19
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
27
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
28 Given two datasets of mutation data as formatted for the UCSC Xena Browser, merge them to produce a third dataset that is the union of the first two. The new dataset will contain all mutations from either dataset.
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
29
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
30 To maintain provenance, this script also outputs a second matrix, with one row for each sample ID that appears in the output dataset, and two columns per row indicating which input dataset(s) contained some mutation data for that sample. By default, the input dataset name is used to indicate which input file each column came from. Optionally, the user can specify descriptive labels to be used in place of the dataset names. </help>
371579dd9bc6 Uploaded
melissacline
parents:
diff changeset
31 </tool>