Mercurial > repos > ebi-gxa > seurat_normalise_data
changeset 0:619fead82856 draft
planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
author | ebi-gxa |
---|---|
date | Wed, 03 Apr 2019 11:20:42 -0400 |
parents | |
children | 48174ec556de |
files | README seurat_macros.xml seurat_normalise_data.xml |
diffstat | 3 files changed, 127 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README Wed Apr 03 11:20:42 2019 -0400 @@ -0,0 +1,1 @@ +Seurat tools
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/seurat_macros.xml Wed Apr 03 11:20:42 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>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/seurat_normalise_data.xml Wed Apr 03 11:20:42 2019 -0400 @@ -0,0 +1,76 @@ +<tool id="seurat_normalise_data" name="Seurat NormaliseData" version="2.3.1+galaxy1"> + <description>normalise data</description> + <macros> + <import>seurat_macros.xml</import> + </macros> + <expand macro="requirements" /> + <expand macro="version" /> + <command detect_errors="exit_code"><![CDATA[ +seurat-normalise-data.R + +--input-object-file '$input' +#if $norm: + --normalization-method $norm +#end if +#if $assay: + --assay-type '$assay' +#end if +#if $scale: + --scale-factor $scale +#end if +--output-object-file '$output' +]]></command> + + <inputs> + <param name="input" argument="--input-object-file" type="data" format="rdata" label="Seurat RDS object" help="Possibly the output of Seurat filter cells or Seurat create object." /> + <param name="norm" argument="--normalization-method" type="text" optional="True" label="Normalisation method" help = "Method for normalization. Default is log-normalization (LogNormalize)."/> + <param name="assay" argument="--assay-type" type="text" optional="True" label="Assay type" help = "Type of assay to normalize for (default is RNA), but can be changed for multimodal analyses."> + <validator type="regex" message="Please only use letters">^[\(\w\)]+$</validator> + </param> + <param name="scale" argument="--scale-factor" type="integer" optional="True" label="Scale factor" help="Sets the scale factor for cell-level normalization"/> + </inputs> + + <outputs> + <data name="output" format="rdata" from_work_dir="*.rds" label="${tool.name} on ${on_string}: RDS file"/> + </outputs> + + <tests> + <test> + <param name="input" ftype="rdata" value="seurat.rds"/> + <output name="output" ftype="rdata" value="out_norm.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 normalises a Seurat RDS object. + +----- + +**Inputs** + + * Seurat RDS object. Possibly the output of Seurat filter cells or Seurat create object. + * Normalisation method. Method for normalization. Default is log-normalization (LogNormalize). + * Assay type. Type of assay to normalize for (default is RNA), but can be changed for multimodal analyses. + * Scale factor. Sets the scale factor for cell-level normalization. Default: 1000 + +----- + +**Outputs** + + * Seurat RDS object with normalised matrix. + +.. _Seurat: https://www.nature.com/articles/nbt.4096 +.. _Satija Lab: https://satijalab.org/seurat/ + +@VERSION_HISTORY@ +]]></help> + <expand macro="citations" /> +</tool>