Mercurial > repos > ebi-gxa > seurat_filter_cells

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Wed Apr 03 11:16:07 2019 -0400
@@ -0,0 +1,1 @@
+Seurat tools
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/seurat_filter_cells.xml	Wed Apr 03 11:16:07 2019 -0400
@@ -0,0 +1,84 @@
+<tool id="seurat_filter_cells" name="Seurat FilterCells" version="2.3.1+galaxy1">
+    <description>filter cells in a Seurat object</description>
+    <macros>
+        <import>seurat_macros.xml</import>
+    </macros>
+    <expand macro="requirements" />
+    <expand macro="version" />
+    <command detect_errors="exit_code"><![CDATA[
+seurat-filter-cells.R
+
+--input-object-file '$input'
+#if $subset:
+    --subset-names '$subset'
+#else
+    --subset-names nUMI
+#end if
+#if $low:
+--low-thresholds $low
+#end if
+#if $high:
+--high-thresholds $high
+#end if
+#if $cells:
+    --cells-use $cells
+#end if
+--output-object-file '$output'
+]]></command>
+
+    <inputs>
+        <param name="input" argument="--input-object-file" type="data" format="rdata" label="Seurat RDS object" help="Output from Seurat create object." />
+        <param name="subset" argument="--subset-names" type="text" label="Subset names" optional="True" help="Parameters to subset on. Eg, the name of a gene, PC1, a column name in object@meta.data, etc. Any argument that can be retreived using FetchData. Multiple values can be separated by colons (:).">
+            <validator type="regex" message="Please only use letters or numbers">^[\(\w\)]+$</validator>
+        </param>
+        <param name="low" argument="--low-thresholds" type="float" optional="True" label="Low threshold for filtering cells" help="Multiple values can be separated by colons (:) and should have same length as provided for `Subset names`." />
+        <param name="high" argument="--high-thresholds" type="float" optional="True" label="High threshold for filtering cells" help="Multiple values can be separated by colons (:) and should have same length as provided for `Subset names`." />
+        <param name="cells" argument="--cells-use" type="text" min="0" optional="True" help="Comma-separated list of cell names to use as a subset." label="Cells to use" />
+    </inputs>
+
+    <outputs>
+        <data name="output" format="rdata" from_work_dir="*.rds" label="${tool.name} on ${on_string}: Seurat RDS"/>
+    </outputs>
+
+    <tests>
+        <test>
+            <param name="input" ftype="rdata" value="seurat.rds"/>
+            <output name="output" ftype="rdata" value="out_filter.rds" compare="sim_size"/>
+        </test>
+    </tests>
+    <help><![CDATA[
+.. class:: infomark
+
+**What it does**
+
+Seurat_ is a toolkit for quality control, analysis, and exploration of single cell RNA sequencing data.
+It is developed and maintained by the `Satija Lab`_ at NYGC. Seurat aims to enable users to identify and
+interpret sources of heterogeneity from single cell transcriptomic measurements, and to integrate diverse
+types of single cell data.
+
+This tool filters a Seurat RDS object.
+
+-----
+
+**Inputs**
+
+    * Seurat RDS object. Probably the one produced by Seurat create object.
+    * Subset names. A list of attributes to subset on, colon separated (:).
+    * Low thresholds. A minimum value for each of the attributes set in subset names, again, colon separated (:). Optional.
+    * High thresholds. A maximum value for each of the attributes set in subset names, again, colon separated (:). Optional.
+    * Cells to use. A list of cell names/idenfifiers to filter positively by.
+
+-----
+
+**Outputs**
+
+    * Seurat RDS object filtered according to the inputs.
+
+.. _Seurat: https://www.nature.com/articles/nbt.4096
+.. _Satija Lab: https://satijalab.org/seurat/
+
+@VERSION_HISTORY@
+
+]]></help>
+      <expand macro="citations" />
+</tool>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/seurat_macros.xml	Wed Apr 03 11:16:07 2019 -0400
@@ -0,0 +1,50 @@
+<?xml version="1.0"?>
+<macros>
+
+    <token name="@VERSION@">0.0.5</token>
+
+    <xml name="requirements">
+        <requirements>
+            <requirement type="package" version="@VERSION@">seurat-scripts</requirement>
+        </requirements>
+    </xml>
+
+    <xml name="version">
+    	<version_command><![CDATA[
+echo $(R --version | grep version | grep -v GNU)", seurat version" $(R --vanilla --slave -e "library(seurat); cat(sessionInfo()\$otherPkgs\$seurat\$Version)" 2> /dev/null | grep -v -i "WARNING: ")
+    ]]></version_command>
+    </xml>
+
+    <xml name="genes-use-input">
+      <param name="genes_use" argument="--genes-use" optional="true" type="data" format="tsv, txt" label="Genes to use" help="A file with gene names to use in construction of SNN graph if building directly based on expression data rather than a dimensionally reduced representation (i.e. PCs)."/>
+    </xml>
+    <xml name="dims-use-input">
+      <param name="dims_use" argument="--dims-use" min="1" optional="true" type="integer" label="PCA Dimensions to use" help="Number of PCs (dimensions) to use in construction of the SNN graph."/>
+    </xml>
+
+    <token name="@VERSION_HISTORY@"><![CDATA[
+**Version history**
+
+0.0.1: Initial contribution. Maria Doyle, https://github.com/mblue9.
+
+2.3.1+galaxy0: Improved documentation and further exposition of all script's options. Pablo Moreno, Jonathan Manning and Ni Huang, Expression Atlas team https://www.ebi.ac.uk/gxa/home  at
+EMBL-EBI https://www.ebi.ac.uk/. Parts obtained from wrappers from Christophe Antoniewski(https://github.com/drosofff) and Lea Bellenger(https://github.com/bellenger-l).
+      ]]></token>
+
+
+    <xml name="citations">
+        <citations>
+            <citation type="doi">10.1038/nbt.4096</citation>
+            <citation type="bibtex">
+              @misc{r-seurat-scripts.git,
+              author = {Jonathan Manning, Pablo Moreno, EBI Gene Expression Team},
+              year = {2018},
+              title = {Seurat-scripts: command line interface for Seurat},
+              publisher = {GitHub},
+              journal = {GitHub repository},
+              url = {https://github.com/ebi-gene-expression-group/r-seurat-scripts.git},
+            }
+            </citation>
+        </citations>
+    </xml>
+</macros>