Mercurial > repos > gaelcge > cellranger_atac_galaxy

annotate cellranger_atac.xml @ 0:a62bafb1aaf8 draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
author gaelcge
date Tue, 02 Aug 2022 19:42:44 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
1 <tool id="cellranger_atac" name="CellRanger ATAC" version="0.1.0" python_template_version="3.5">
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
2 <description>performs processing of 10x single-cell ATAC-seq data.</description>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
3 <requirements>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
4 </requirements>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
5 <command detect_errors="exit_code"><![CDATA[
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
6 mkdir ./fastq_dir &&
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
7 #for $i1 in $fastq_i1#
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
8 ln -s $i1 ./fastq_dir/$i1.element_identifier;
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
9 #end for#
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
10
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
11 #for $r1 in $fastq_r1#
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
12 ln -s $r1 ./fastq_dir/$r1.element_identifier;
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
13 #end for#
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
14
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
15 #for $r2 in $fastq_r2#
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
16 ln -s $r2 ./fastq_dir/$r2.element_identifier;
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
17 #end for#
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
18
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
19 #for $r3 in $fastq_r3#
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
20 ln -s $r3 ./fastq_dir/$r3.element_identifier;
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
21 #end for#
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
22 /cellranger/cellranger-atac count --id=$sample_ID --reference=/references/refdata-cellranger-arc-GRCh38-2020-A-2.0.0/ --fastqs ./fastq_dir --sample=$sample_name --localcores=8 --localmem=80 --disable-ui &&
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
23 ln -s $sample_ID cellranger_atac
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
24 ]]></command>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
25 <inputs>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
26 <param type="data" name="fastq_i1" label="Select the I1 fastq file (Dual index i7 read (optional)):" format="fastq.gz" multiple="true"/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
27 <param type="data" name="fastq_r1" label="Select the read1 (R1) fastq file (BC):" format="fastq.gz" multiple="true"/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
28 <param type="data" name="fastq_r2" label="Select the Dual index i5 read file (R2/I2):" format="fastq.gz" multiple="true"/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
29 <param type="data" name="fastq_r3" label="Select the read (R3) fastq file (DNA):" format="fastq.gz" multiple="true"/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
30 <param type="text" name="sample_ID" label="What is the sample ID? (no spaces or special characters! example: my_sample)" optional="false"/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
31 <param type="text" name="sample_name" label="What is the sample name?" optional="false"/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
32 </inputs>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
33 <outputs>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
34 <data name="Per-barcode fragment counts and metrics" label="singlecell.csv" format="csv" from_work_dir="cellranger_atac/outs/singlecell.csv"/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
35 <collection type="list" label="BAM files" name="">
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
36 <data name="possorted_bam.bam" label="possorted_bam.bam" format="bam" from_work_dir="cellranger_atac/outs/possorted_bam.bam"/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
37 <data name="possorted_bam.bai" label="possorted_bam.bai" format="bai" from_work_dir="cellranger_atac/outs/possorted_bam.bam.bai"/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
38 </collection>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
39 <data name="Summary of all data metrics" label="summary.json" format="json" from_work_dir='cellranger_atac/outs/summary.json'/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
40 <data name="HTML file summarizing data and analysis" label="web_summary.html" format="html" from_work_dir="cellranger_atac/outs/web_summary.html" />
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
41 <collection type="list" label="Filtered peak bc matrix" name="filtered_peak_bc_matrix">
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
42 <data name="barcodes.tsv" label="barcodes.tsv" format="tsv" from_work_dir='cellranger_atac/outs/filtered_peak_bc_matrix/barcodes.tsv'/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
43 <data name="peaks.bed" label="peaks.bed" format="bed" from_work_dir='cellranger_atac/outs/filtered_peak_bc_matrix/peaks.bed'/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
44 </collection>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
45 <data name="Raw peak barcode matrix in hdf5 format" label="raw_peak_bc_matrix.h5" format="h5" from_work_dir='cellranger_atac/outs/raw_peak_bc_matrix.h5'/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
46 <data name="Filtered peak barcode matrix in hdf5 format" label="filtered_peak_bc_matrix.h5" format="h5" from_work_dir='cellranger_atac/outs/filtered_peak_bc_matrix.h5'/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
47 <data name="fragments.tsv.gz" label="fragments.tsv.gz" format="bgzip" from_work_dir='cellranger_atac/outs/fragments.tsv.gz'/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
48 <data name="fragments.tsv.gz.tbi" label="fragments.tsv.gz.tbi" format="text" from_work_dir='cellranger_atac/outs/fragments.tsv.gz.tbi'/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
49 <data name="Filtered tf barcode matrix in hdf5 format" label="filtered_tf_bc_matrix.h5" format="h5" from_work_dir='cellranger_atac/outs/filtered_tf_bc_matrix.h5'/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
50 <data name="Cloupe file" label="cloupe.cloupe" format="data" from_work_dir='cellranger_atac/outs/cloupe.cloupe'/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
51 <data name="csv summarizing important metrics and values" label="summary.csv" format="csv" from_work_dir='cellranger_atac/outs/summary.csv'/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
52 <data name="Annotation of peaks with genes" label="peak_annotation.tsv" format="tsv" from_work_dir='cellranger_atac/outs/peak_annotation.tsv'/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
53 <data name="Peak-motif associations" label="peak_motif_mapping.bed" format="bed" from_work_dir='cellranger_atac/outs/peak_motif_mapping.bed'/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
54 <data name="Filtered CellRanger BC matrix" label="matrix.mtx" format="mtx" from_work_dir='cellranger_atac/outs/filtered_peak_bc_matrix/matrix.mtx'/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
55 <collection type="list" label="Raw peak bc matrix" name="raw_peak_bc_matrix">
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
56 <data name="barcodes.txt" label="barcodes.txt" format="txt" from_work_dir='cellranger_atac/outs/raw_peak_bc_matrix/barcodes.tsv'/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
57 <data name="peaks.bed" label="peaks.bed" format="bed" from_work_dir='cellranger_atac/outs/raw_peak_bc_matrix/peaks.bed'/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
58 <data name="matrix.mtx" label="matrix.mtx" format="mtx" from_work_dir='cellranger_atac/outs/raw_peak_bc_matrix/matrix.mtx'/>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
59 </collection>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
60 </outputs>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
61 <help><![CDATA[
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
62 Disclaimer: This wrapper for CellRanger-ATAC is not developed or supported by 10x Genomics. This wrapper was written by scientists at GenAP to help facilitate usage of CellRanger tools inside of Galaxy. Please find the full, official 10x Genomics licensing information at : https://support.10xgenomics.com/docs/license.
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
63
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
64 What is CellRanger ATAC?
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
65 https://support.10xgenomics.com/single-cell-atac/software/pipelines/latest/what-is-cell-ranger-atac
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
66
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
67 Naming convention of FASTQ files internally in Galaxy follows thes guidelines: https://support.10xgenomics.com/single-cell-atac/software/pipelines/latest/using/fastq-input#rightname
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
68
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
69 Installation:
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
70 1) Install this wrapper via the Galaxy toolshed.
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
71 2) CellRanger-ATAC (v2.0.0) is required for this r
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
72
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
73
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
74 To use this tool, we assume that cellranger-atac (v.2.0.0) is available to Galaxy on the system, via the command cellranger-atac. Unfortunately at this point, we cannot include Cellranger-ATAC as
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
75 part of this wrapper due to Licensing and distribution limitations. For more information on how to install CellRanger-ATAC on your system, please see :
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
76 https://support.10xgenomics.com/single-cell-atac/software/pipelines/latest/installation
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
77 ]]></help>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
78 <citations>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
79 <citation type="bibtex">
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
80 @misc{renameTODO,
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
81 author = 10x Genomics,
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
82 year = 2021,
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
83 title = CellRanger-ATAC,
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
84 url = {https://support.10xgenomics.com/single-cell-atac/software/pipelines/latest/using/fastq-input#ATACIntro},
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
85 }</citation>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
86 </citations>
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
87 </tool>