Mercurial > repos > ebi-gxa > dropletutils_empty_drops

annotate dropletutils-empty-drops.xml @ 1:3b67b996365f draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 3fc448754d6720855f781caa7938e33d3961b092"
author ebi-gxa
date Thu, 16 Apr 2020 08:51:20 +0000
parents 79ef5924cd7a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
2 <tool id="dropletutils_empty_drops" name="DropletUtils emptyDrops" version="@TOOL_VERSION@+galaxy1">
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
3 <description>Distinguish between droplets containing cells and ambient RNA in a droplet-based single-cell RNA sequencing experiment.</description>
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
4 <macros>
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
5 <import>dropletutils_macros.xml</import>
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
6 </macros>
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
7 <expand macro="requirements"/>
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
9 dropletutils-empty-drops.R --input-object-file "${input}" --output-object-file "${output_rdata}" --output-text-file "${output_txt}" --lower "${lower}" --niters "${niters}" --filter-fdr "${filter_fdr}" --test-ambient "${testambient}" --filter-empty "${filter_empty}"
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
10 #if $ignore != ''
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
11 --ignore $ignore
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
12 #end if
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
13 #if $retain != ''
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
14 --retain $retain
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
15 #end if
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
16 ]]></command>
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
17
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
18 <inputs>
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
19 <param name="input" argument="--input-object-file" type="data" format="rdata" label="SingleCellExperiment rdata object" help="e.g. Output from DropletUtils Read10x." />
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
20 <param name="lower" argument="--lower" type="integer" optional="True" label="UMI count lower bound" value='100' help="A numeric scalar specifying the lower bound on the total UMI count, at or below which all barcodes are assumed to correspond to empty droplets." />
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
21 <param name="niters" argument="--niters" type="integer" optional="True" value='1000' label="Number of iterations" help="An integer scalar specifying the number of iterations to use for the Monte Carlo p-value calculations." />
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
22 <param name="filter_fdr" argument="--filter-fdr" type="float" value='0.01' label="FDR filter for removal of barcodes with no cells" />
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
23 <param name="testambient" argument="--test-ambient" type="boolean" checked="false" label="Should results be returned for barcodes with totals less than or equal to the value of 'lower'?"/>
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
24 <param name="ignore" argument="--ignore" type="integer" optional="True" value='' label="Ignore barcodes threshold" help="A numeric scalar specifying the lower bound on the total UMI count, at or below which barcodes will be ignored. (default: none)" />
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
25 <param name="retain" argument="--retain" type="integer" optional="True" label="Retain barcodes threshold" help="A numeric scalar specifying the threshold for the total UMI count above which all barcodes are assumed to contain cells. (default: none)" />
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
26 <param name="filter_empty" argument="--filter-empty" type="boolean" checked="false" label="Should barcodes estimated to have no cells be removed from the output object?"/>
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
27 </inputs>
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
28
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
29 <outputs>
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
30 <data name="output_rdata" format="rdata" label="${tool.name} on ${on_string}: serialized SingleCellExperiment object"/>
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
31 <data name="output_txt" format="txt" label="${tool.name} on ${on_string}: tabular output"/>
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
32 </outputs>
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
33
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
34 <help><![CDATA[
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
35 ========================================================================================================================================
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
36 Distinguish between droplets containing cells and ambient RNA in a droplet-based single-cell RNA sequencing experiment. (`emptyDrops()`)
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
37 ========================================================================================================================================
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
38
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
39 This tool takes a SingleCellExeriment object and esitmates empty cells. From ?emptyDrops():
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
40
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
41 The emptyDrops function combines the results of testEmptyDrops with barcodeRanks to identify droplets that are likely to contain cells. Barcodes that contain more than retain total counts are always retained. This ensures that large cells with profiles that are very similar to the ambient pool are not inadvertently discarded. If retain is not specified, it is set to the total count at the knee point detected by barcodeRanks. Manual specification of retain may be useful if the knee point was not correctly identified in complex log-rank curves. Users can also set retain=Inf to disable automatic retention of barcodes with large totals.
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
42
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
43 The Benjamini-Hochberg correction is also applied to the Monte Carlo p-values to correct for multiple testing. Cells can then be defined by taking all barcodes with significantly non-ambient profiles, e.g., at a false discovery rate of 0.1%. All barcodes with total counts above K (or retain) are assigned p-values of zero during correction, reflecting our assumption that they are true positives. This ensures that their Monte Carlo p-values do not affect the correction of other genes, and also means that they will have FDR values of zero. Nonetheless, their original Monte Carlo p-values are still reported in the output.
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
44
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
45 @HELP@
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
46 ]]></help>
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
47 <expand macro="citations"/>
79ef5924cd7a "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 848d53f8dc662f24cc0443da6e5cacbd96daf5fe"
ebi-gxa
parents:
diff changeset
48 </tool>