annotate mageck_test.xml @ 2:bd1b6afd52d1 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
author iuc
date Wed, 04 Apr 2018 11:02:15 -0400
parents afe7da8933c7
children ed0926150216
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
1 <?xml version="1.0"?>
1
afe7da8933c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 2eea865fe331694058922292e5681b96f4f0b4c7
iuc
parents: 0
diff changeset
2 <tool id="mageck_test" name="MAGeCKs test" version="@VERSION@.1" >
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
3 <description>- given a table of read counts, perform the sgRNA and gene ranking</description>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
4 <macros>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
5 <import>mageck_macros.xml</import>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
6 </macros>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
7 <expand macro="requirements" />
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
8 <expand macro="version" />
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
9 <command detect_errors="exit_code"><![CDATA[
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
10
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
11 mageck test
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
12 -k '$count_table'
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
13
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
14 #if $sampleids.sample_select == "treated":
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
15 -t '$sampleids.treatment_id'
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
16 #elif $sampleids.sample_select == "control":
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
17 --day0-label '$sampleids.day0_label'
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
18 #end if
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
19
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
20 #if '$control_id':
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
21 -c '$control_id'
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
22 #end if
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
23
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
24 -n output
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
25
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
26 $out.normcounts
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
27
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
28 $out.pdfreport
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
29
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
30 #if $adv.norm_method:
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
31 --norm-method $adv.norm_method
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
32 #end if
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
33
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
34 #if $adv.fdr_threshold:
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
35 --gene-test-fdr-threshold $adv.fdr_threshold
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
36 #end if
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
37
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
38 #if $adv.adjust_method:
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
39 --adjust-method $adv.adjust_method
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
40 #end if
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
41
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
42 $adv.var_samples
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
43
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
44 #if $adv.sort_criteria:
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
45 --sort-criteria $adv.sort_criteria
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
46 #end if
1
afe7da8933c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 2eea865fe331694058922292e5681b96f4f0b4c7
iuc
parents: 0
diff changeset
47
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
48 #if $adv.remove_zero:
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
49 --remove-zero $adv.remove_zero
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
50 #end if
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
51
1
afe7da8933c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 2eea865fe331694058922292e5681b96f4f0b4c7
iuc
parents: 0
diff changeset
52 #if $adv.remove_zero_threshold:
afe7da8933c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 2eea865fe331694058922292e5681b96f4f0b4c7
iuc
parents: 0
diff changeset
53 --remove-zero-threshold $adv.remove_zero_threshold
afe7da8933c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 2eea865fe331694058922292e5681b96f4f0b4c7
iuc
parents: 0
diff changeset
54 #end if
afe7da8933c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 2eea865fe331694058922292e5681b96f4f0b4c7
iuc
parents: 0
diff changeset
55
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
56 #if $adv.lfc_method:
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
57 --gene-lfc-method $adv.lfc_method
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
58 #end if
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
59
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
60 #if $adv.control_sgrna:
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
61 --control-sgrna $adv.control_sgrna
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
62 #end if
1
afe7da8933c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 2eea865fe331694058922292e5681b96f4f0b4c7
iuc
parents: 0
diff changeset
63
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
64 #if $adv.cnv_norm:
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
65 --cnv-norm $adv.cnv_norm
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
66 #end if
1
afe7da8933c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 2eea865fe331694058922292e5681b96f4f0b4c7
iuc
parents: 0
diff changeset
67
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
68 #if $adv.cell_line:
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
69 --cell-line $adv.cell_line
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
70 #end if
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
71
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
72 ]]></command>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
73 <inputs>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
74 <param name="count_table" argument="--count-table" type="data" format="tabular" label="Counts file" help="A tab-separated file of read counts. See Help below for format" />
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
75 <conditional name="sampleids">
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
76 <param name="sample_select" type="select" label="Specify Treated samples or Control"
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
77 help="You can choose to either specify the treated samples or the control">
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
78 <option value="treated">Treated samples</option>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
79 <option value="control">Control sample</option>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
80 </param>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
81 <when value="treated">
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
82 <param name="treatment_id" argument="--treatment-id" type="text" label="Treated Sample Labels (or Indexes)" help="If sample label is provided, the labels must match the labels in the first line of the count table, separated by comma (,); for example, HL60.final,KBM7.final. For sample index, 0,2 means the 1st and 3rd samples are treatment experiments. See Help below for a detailed description.">
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
83 <validator type="regex" message="Please only use letters, numbers or underscores in sample labels, and separate labels by commas">^[\w,]+$</validator>
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
84 </param>
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
85 </when>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
86 <when value="control">
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
87 <param name="day0_label" argument="--day0-label" type="text" optional="true" value="" label="Control Sample Label" help="Specify the label for the control sample. For every other sample label, the module will treat it as a treatment condition and compare with control sample (usually day 0 or plasmid)">
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
88 <validator type="regex" message="Please only use letters, numbers or underscores in sample label">^[\w]+$</validator>
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
89 </param>
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
90 </when>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
91 </conditional>
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
92 <param name="control_id" argument="--control-id" type="text" optional="true" label="Control Sample Labels (or Indexes)" help="If sample label is provided, the labels must match the labels in the first line of the count table, separated by comma (,). Default is all the samples not specified in treatment experiments. See Help below for a detailed description.">
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
93 <validator type="regex" message="Please only use letters, numbers or underscores in sample labels, and separate labels by commas">^[\w,]+$</validator>
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
94 </param>
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
95 <section name="out" title="Output Options">
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
96 <param name="normcounts" argument="--normcounts-to-file" type="boolean" truevalue="--normcounts-to-file" falsevalue="" checked="false" optional="true" label="Output normalized counts file" help="Default: No" />
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
97 <param name="pdfreport" argument="--pdf-report" type="boolean" truevalue="--pdf-report" falsevalue="" checked="false" optional="true" label="Output plots" help="Generate PDF of the plots. Default: No" />
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
98 <param name="rfilesOpt" type="boolean" truevalue="True" falsevalue="" checked="false" optional="true" label="Output R files" help="Output the .R and .Rnw files to generate the PDF report. The gene summary file will also be output as it is required to regenerate the report. Default: No" />
1
afe7da8933c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 2eea865fe331694058922292e5681b96f4f0b4c7
iuc
parents: 0
diff changeset
99 <param name="out_log" type="boolean" truevalue="True" falsevalue="" checked="false" label="Output Log file" help="This file includes the logging information during the execution. Default: No" />
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
100 </section>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
101
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
102 <section name="adv" title="Advanced Options">
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
103 <param name="norm_method" argument="--norm-method" optional="true" type="select" label="Method for normalization" help="If control is specified, the size factor will be estimated using control sgRNAs specified in --control-sgrna option. Default: Median" >
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
104 <option value="median" selected="True">Median</option>
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
105 <option value="none">None</option>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
106 <option value="total">Total</option>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
107 <option value="control">Control</option>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
108 </param>
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
109 <param name="fdr_threshold" argument="--gene-test-fdr-threshold" type="float" min="0" max="1" optional="true" label="Gene test FDR-adjusted Threshold" help="FDR threshold for gene test. Default: 0.25"/>
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
110 <param name="adjust_method" argument="--adjust-method" type="select" optional="true" label="P-Value Adjustment Method" help="Method for sgRNA-level p-value adjustment, including False Discovery Rate (FDR), Holm's method (Holm), or Pounds's method (Pounds). Default: FDR">
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
111 <option value="fdr" selected="True">FDR</option>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
112 <option value="holm">Holm</option>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
113 <option value="pounds">Pounds</option>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
114 </param>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
115 <param name="var_samples" argument="--variance-from-all-samples" type="boolean" truevalue="--variance-from-all-samples" falsevalue="" checked="false" optional="true" label="Estimate the variance from all samples, instead of from only control samples" help="Use this option only if you believe there are relatively few essential sgRNAs or genes between control and treatment samples" />
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
116 <expand macro="sort_criteria" />
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
117 <param name="remove_zero" argument="--remove-zero" type="select" optional="true" label="Remove zero" help="Remove sgRNAs whose mean value is zero in Control, Treatment, Both control/treatment, or Any control/treatment sample. Default: Both (remove those sgRNAs that are zero in both control and treatment samples)" >
1
afe7da8933c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 2eea865fe331694058922292e5681b96f4f0b4c7
iuc
parents: 0
diff changeset
118 <option value="none" >None</option>
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
119 <option value="control">Control</option>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
120 <option value="treatment">Treatment</option>
1
afe7da8933c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 2eea865fe331694058922292e5681b96f4f0b4c7
iuc
parents: 0
diff changeset
121 <option value="both" selected="True">Both</option>
afe7da8933c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 2eea865fe331694058922292e5681b96f4f0b4c7
iuc
parents: 0
diff changeset
122 <option value="any">Any</option>
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
123 </param>
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
124 <param name="remove_zero_threshold" argument="--remove-zero-threshold" type="float" optional="true" label="Remove zero Threshold" help="sgRNA normalized count threshold to be considered removed in the --remove-zero option. Default: 0"/>
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
125 <param name="lfc_method" argument="--gene-lfc-method" type="select" optional="true" label="Gene Log-Fold Change Method." help="Method to calculate gene log fold changes (LFC) from sgRNA LFCs. Available methods include the median/mean of all sgRNAs (median/mean), or the median/mean sgRNAs that are ranked in front of the alpha cutoff in RRA (alphamedian/alphamean), or the sgRNA that has the second strongest LFC (secondbest). In the alphamedian/alphamean case, the number of sgRNAs correspond to the goodsgrna column in the output, and the gene LFC will be set to 0 if no sgRNA is in front of the alpha cutoff. Default: Median. (new since v0.5.5)">
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
126 <option value="median" selected="True">Median</option>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
127 <option value="alphamedian">Alphamedian</option>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
128 <option value="mean">Mean</option>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
129 <option value="alphamean">Alphamean</option>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
130 <option value="secondbest">Secondbest</option>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
131 </param>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
132 <param name="control_sgrna" argument="--control-sgrna" type="data" format="tabular" optional="true" label="Control sgRNAs file" help="A list of control sgRNAs for normalization and for generating the null distribution of RRA" />
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
133 <param name="cnv_norm" argument="--cnv-norm" type="data" format="tabular" optional="true" label="CNV profile file" help="A tab-delimited file containing the CNV status for each gene. See Help below for more information and format." />
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
134 <param name="cell_line" argument="--cell-line" type="text" optional="true" label="Cell line column" help="Name of the column from the CNV profile file to use. See Help below for more information" />
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
135 </section>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
136 </inputs>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
137
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
138 <outputs>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
139 <data name="gene_summary" format="tabular" from_work_dir="output.gene_summary.txt" label="${tool.name} on ${on_string}: Gene Summary" />
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
140 <data name="sgrna_summary" format="tabular" from_work_dir="output.sgrna_summary.txt" label="${tool.name} on ${on_string}: sgRNA Summary" />
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
141 <data name="log" format="tabular" from_work_dir="output.log" label="${tool.name} on ${on_string}: Log">
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
142 <filter>out['out_log'] is True</filter>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
143 </data>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
144 <data name="normcounts" format="tabular" from_work_dir="output.normalized.txt" label="${tool.name} on ${on_string}: sgRNA Normalized Counts">
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
145 <filter>out['normcounts'] is True</filter>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
146 </data>
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
147 <data name="plots" format="pdf" from_work_dir="output.pdf" label="${tool.name} on ${on_string}: PDF Report">
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
148 <filter>out['pdfreport'] is True</filter>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
149 </data>
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
150 <data name="rscript" format="txt" from_work_dir="output.R" label="${tool.name} on ${on_string}: R file" >
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
151 <filter>out['rfilesOpt'] is True</filter>
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
152 </data>
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
153 <data name="rnwfile" format="txt" from_work_dir="output_summary.Rnw" label="${tool.name} on ${on_string}: Rnw file" >
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
154 <filter>out['rfilesOpt'] is True</filter>
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
155 </data>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
156 </outputs>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
157 <tests>
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
158 <!-- Ensure MAGeCK's default output works -->
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
159 <test expect_num_outputs="2">
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
160 <param name="count_table" value="in.test.sample.txt" ftype="tabular" />
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
161 <param name="treatment_id" value="HL60_final,KBM7_final" />
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
162 <param name="control_id" value="HL60_initial,KBM7_initial" />
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
163 <output name="gene_summary" file="out.test.gene_summary.txt"/>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
164 <output name="sgrna_summary" file="out.test.sgrna_summary.txt"/>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
165 </test>
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
166 <!-- Ensure MAGeCK's additional outputs works -->
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
167 <test expect_num_outputs="7">
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
168 <param name="count_table" value="in.test.sample.txt" ftype="tabular" />
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
169 <param name="treatment_id" value="HL60_final,KBM7_final" />
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
170 <param name="control_id" value="HL60_initial,KBM7_initial" />
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
171 <param name="out_log" value="True" />
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
172 <param name="normcounts" value="True" />
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
173 <param name="pdfreport" value="True" />
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
174 <param name="rfilesOpt" value="True" />
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
175 <output name="gene_summary" file="out.test.gene_summary.txt"/>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
176 <output name="sgrna_summary" file="out.test.sgrna_summary.txt"/>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
177 <output name="normcounts" file="out.test.normalized.txt"/>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
178 <output name="log" file="out.test.log.txt" compare="sim_size"/>
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
179 <output name="plots" file="out.test.plots.pdf" compare="sim_size"/>
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
180 <output name="rscript" file="out.test.R" />
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
181 <output name="rnwfile" file="output_summary.Rnw" />
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
182 </test>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
183 </tests>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
184
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
185 <help><![CDATA[
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
186 .. class:: infomark
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
187
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
188 **What it does**
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
189
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
190 `Model-based Analysis of Genome-wide CRISPR-Cas9 Knockout` (MAGeCK) is a computational tool to identify important genes from the recent genome-scale CRISPR-Cas9 knockout screens (or GeCKO) technology. MAGeCK can be used for prioritizing single-guide RNAs, genes and pathways in genome-scale CRISPR/Cas9 knockout screens. MAGeCK identifies both positively and negatively selected genes simultaneously and reports robust results across different experimental conditions. MAGeCK is developed and maintained by Wei Li and Han Xu from `Prof. Xiaole Shirley Liu's lab`_ at the Department of Biostatistics and Computational Biology, Dana-Farber Cancer Institute and Harvard School of Public Health. MAGeCK has been used to identify functional lncRNAs from screens with close to `100% validation rate`_.
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
191
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
192 .. _`Model-based Analysis of Genome-wide CRISPR-Cas9 Knockout`: https://genomebiology.biomedcentral.com/articles/10.1186/s13059-014-0554-4
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
193 .. _`100% validation rate`: https://sourceforge.net/p/mageck/wiki/Home/
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
194 .. _`Prof. Xiaole Shirley Liu's lab`: http://liulab.dfci.harvard.edu/
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
195
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
196 -----
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
197
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
198 **mageck test**
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
199
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
200 This tests and ranks sgRNAs and genes based on the table provided.
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
201
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
202 **Inputs**
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
203
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
204 **sgRNA count file**
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
205
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
206 The input sgRNA count file be tab-delimited and list the names of the sgRNA, the gene it is targeting, followed by the read counts in each sample. A header line is optional. For example in the studies of T. Wang et al. Science 2014, there are 4 CRISPR screening samples, and they are labeled as: HL60.initial, KBM7.initial, HL60.final, KBM7.final, see below.
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
207
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
208 Example:
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
209
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
210 ============== ======== ================ ================ ============== ==============
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
211 **sgRNA** **gene** **HL60.initial** **KBM7.initial** **HL60.final** **KBM7.final**
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
212 -------------- -------- ---------------- ---------------- -------------- --------------
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
213 A1CF_m52595977 A1CF 213 274 883 175
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
214 A1CF_m52596017 A1CF 294 412 1554 1891
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
215 A1CF_m52596056 A1CF 421 368 566 759
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
216 A1CF_m52603842 A1CF 274 243 314 855
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
217 A1CF_m52603847 A1CF 0 50 145 266
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
218 ============== ======== ================ ================ ============== ==============
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
219
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
220 **Sample Labels**
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
221
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
222 In the Treatment and Control inputs above, you can use either Sample Label or Sample Index to specify samples. If sample label is used, the labels MUST match the sample labels in the first line of the count table. For example, "HL60.final,KBM7.final".
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
223 You can also use sample index to specify samples. The index of the sample is the order it appears in the sgRNA read count file, starting from 0. The index is used in the Treatment and Control inputs. In the example above, there are four samples, and the index of each sample is as follows:
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
224
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
225 ============ =======
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
226 *sample* *index*
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
227 ------------ -------
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
228 HL60.initial 0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
229 KBM7.initial 1
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
230 HL60.final 2
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
231 KBM7.final 3
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
232 ============ =======
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
233
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
234 **Control sgRNA file**
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
235
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
236 The optional Control sgRNA file is used to generate null distribution when calculating the p values. If this option is not specified, MAGeCK generates the null distribution of RRA scores by assuming all of the genes in the library are non-essential. This approach is sometimes over-conservative, and you can improve this if you know some genes are not essential. By providing the corresponding sgRNA IDs in this option, MAGeCK will have a better estimation of p values. To use this option, you need to prepare a text file specifying the IDs of control sgRNAs, one line for one sgRNA ID.
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
237
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
238 -----
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
239
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
240 **Outputs**
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
241
2
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
242 This tool outputs
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
243
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
244 * a ranked sgRNA Summary file
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
245 * a ranked Gene Summary file
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
246
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
247 Optionally, under **Output Options** you can choose to output
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
248
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
249 * a Normalized Counts table
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
250 * a PDF of the plots
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
251 * the .R and .Rnw files to generate the report
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
252 * a Log file of the analysis
bd1b6afd52d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 49e456dda49db1f52fc876f406a10273a408b1a2
iuc
parents: 1
diff changeset
253
0
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
254 **sgRNA Summary file**
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
255
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
256 An example of the sgRNA ranking output is as follows:
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
257
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
258 ================ ======== ================= =================== ================ ============== ======= =============== =========== ========= ========= =========== ============== =========== =====================
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
259 **sgrna** **Gene** **control_count** **treatment_count** **control_mean** **treat_mean** **LFC** **control_var** **adj_var** **score** **p.low** **p.high** **p.twosided** **FDR** **high_in_treatment**
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
260 ---------------- -------- ----------------- ------------------- ---------------- -------------- ------- --------------- ----------- --------- --------- ----------- -------------- ----------- ---------------------
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
261 INO80B_m74682554 INO80B 0.0/0.0 1220.15/1476.14 0.810860 1348.15 10.70 0.0 19.0767 308.478 1.0 1.11022e-16 2.22044e-16 1.57651e-14 True
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
262 NHS_p17705966 NHS 1.62172/3.90887 2327.09/1849.95 2.76529 2088.52 9.54 2.61554 68.2450 252.480 1.0 1.11022e-16 2.22044e-16 1.57651e-14 True
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
263 ================ ======== ================= =================== ================ ============== ======= =============== =========== ========= ========= =========== ============== =========== =====================
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
264
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
265 The contents of each column are as follows:
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
266
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
267 * **sgrna** sgRNA ID
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
268 * **Gene** The targeting gene
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
269 * **control_count** Normalized read counts in control samples
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
270 * **treatment_count** Normalized read counts in treatment samples
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
271 * **control_mean** Mean read counts in control samples
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
272 * **treat_mean** Mean read counts in treatment samples
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
273 * **LFC** The log fold change of sgRNA
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
274 * **control_var** The raw variance in control samples
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
275 * **adj_var** The adjusted variance in control samples
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
276 * **score** The score of this sgRNA
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
277 * **p.low** p-value (lower tail)
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
278 * **p.high** p-value (higher tail)
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
279 * **p.twosided** p-value (two sided)
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
280 * **FDR** false discovery rate
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
281 * **high_in_treatment** Whether the abundance is higher in treatment samples
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
282
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
283
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
284 **Gene Summary file**
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
285
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
286 An example of the gene summary output file is as follows:
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
287
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
288 ======= ======= ============= =============== =========== ============ ================= =========== ============= =============== =========== ============ ================= ===========
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
289 **id** **num** **neg|score** **neg|p-value** **neg|fdr** **neg|rank** **neg|goodsgrna** **neg|lfc** **pos|score** **pos|p-value** **pos|fdr** **pos|rank** **pos|goodsgrna** **pos|lfc**
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
290 ------- ------- ------------- --------------- ----------- ------------ ----------------- ----------- ------------- --------------- ----------- ------------ ----------------- -----------
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
291 ESPL1 12 6.4327e-10 7.558e-06 7.9e-05 1 -2.35 11 0.99725 0.99981 0.999992 615 0 -0.07
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
292 RPL18 12 6.4671e-10 7.558e-06 7.9e-05 2 -2.12 11 0.99799 0.99989 0.999992 620 0 -0.32
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
293 CDK1 12 2.6439e-09 7.558e-06 7.9e-05 3 -1.93 12 1.0 0.99999 0.999992 655 0 -0.12
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
294 ======= ======= ============= =============== =========== ============ ================= =========== ============= =============== =========== ============ ================= ===========
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
295
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
296 The contents of each column is as follows:
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
297
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
298 * **id** Gene ID
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
299 * **num** The number of targeting sgRNAs for each gene
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
300 * **neg|score** The RRA lo value of this gene in negative selection
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
301 * **neg|p-value** The raw p-value (using permutation) of this gene in negative selection
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
302 * **neg|fdr** The false discovery rate of this gene in negative selection
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
303 * **neg|rank** The ranking of this gene in negative selection
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
304 * **neg|goodsgrna** The number of "good" sgRNAs, i.e., sgRNAs whose ranking is below the alpha cutoff (determined by the --gene-test-fdr-threshold option), in negative selection.
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
305 * **neg|lfc** The log fold change of this gene in negative selection
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
306 * **pos|score** The number of targeting sgRNAs for each gene in positive selection (usually the same as num.neg)
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
307 * **pos|score** The RRA lo value of this gene in negative selection
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
308 * **pos|p-value** The raw p-value of this gene in positive selection
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
309 * **pos|fdr** The false discovery rate of this gene in positive selection
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
310 * **pos|rank** The ranking of this gene in positive selection
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
311 * **pos|goodsgrna** The number of "good" sgRNAs, i.e., sgRNAs whose ranking is below the alpha cutoff (determined by the --gene-test-fdr-threshold option), in positive selection.
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
312 * **pos|lfc** The log fold change of this gene in positive selection
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
313
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
314 Genes are ranked by the p.neg field (by default). If you need a ranking by the p.pos, you can use the --sort-criteria option.
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
315
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
316 -----
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
317
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
318 **More Information**
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
319
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
320 **Overview of the MAGeCK algorithm**
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
321
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
322 Briefly, read counts from different samples are first median-normalized to adjust for the effect of library sizes and read count distributions. Then the variance of read counts is estimated by sharing information across features, and a negative binomial (NB) model is used to test whether sgRNA abundance differs significantly between treatments and controls. This approach is similar to those used for differential RNA-Seq analysis. We rank sgRNAs based on P-values calculated from the NB model, and use a modified robust ranking aggregation (RRA) algorithm named α-RRA to identify positively or negatively selected genes. More specifically, α-RRA assumes that if a gene has no effect on selection, then sgRNAs targeting this gene should be uniformly distributed across the ranked list of all the sgRNAs. α-RRA ranks genes by comparing the skew in rankings to the uniform null model, and prioritizes genes whose sgRNA rankings are consistently higher than expected. α-RRA calculates the statistical significance of the skew by permutation, and a detailed description of the algorithm is presented in the Materials and methods section of the `MAGeCK paper`_. Finally, MAGeCK reports positively and negatively selected pathways by applying α-RRA to the rankings of genes in a pathway.
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
323
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
324 For more information on using MAGeCK, see the `MAGeCK website here`_.
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
325
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
326 .. _`MAGeCK paper`: https://genomebiology.biomedcentral.com/articles/10.1186/s13059-014-0554-4
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
327 .. _`MAGeCK website here`: https://sourceforge.net/p/mageck/wiki/QA/#using-mageck
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
328
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
329 ]]></help>
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
330 <expand macro="citations" />
ea8bd0408fc9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mageck commit 3a58259cd0f035510963d470ea8ddbe551aea058-dirty
iuc
parents:
diff changeset
331 </tool>