annotate README.md @ 0:a62bafb1aaf8 draft default tip

"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 # GenAP2 Galaxy implementation of CellRanger-ATAC
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
2 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.
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
3 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
4
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
5 What is CellRanger ATAC?
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
6
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
7 https://support.10xgenomics.com/single-cell-atac/software/pipelines/latest/what-is-cell-ranger-atac
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
8
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
9 Naming convention of FASTQ files internally in Galaxy follows thes guidelines:
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
10
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
11 https://support.10xgenomics.com/single-cell-atac/software/pipelines/latest/using/fastq-input#rightname
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
12
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
13 Installation:
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
14 1) Install this wrapper via the Galaxy toolshed.
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
15 2) CellRanger-ATAC (v2.0.0) is required for this wrapper and should be installed separately (see below).
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
16
a62bafb1aaf8 "planemo upload commit ff0d185541dc4b0a5839fca166f1beb459dee61c"
gaelcge
parents:
diff changeset
17 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 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
18 https://support.10xgenomics.com/single-cell-atac/software/pipelines/latest/installation