Skip to content

Commit

Permalink
Merge pull request #315 from lldelisle/velocyto_wf
Browse files Browse the repository at this point in the history
Add velocyto workflow
  • Loading branch information
mvdbeek authored Jan 26, 2024
2 parents 0a87074 + 1acaeb4 commit ffd260f
Show file tree
Hide file tree
Showing 7 changed files with 654 additions and 0 deletions.
20 changes: 20 additions & 0 deletions workflows/scRNAseq/velocyto/.dockstore.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
version: 1.2
workflows:
- name: Velocyto-on10X-from-bundled
subclass: Galaxy
publish: true
primaryDescriptorPath: /Velocyto-on10X-from-bundled.ga
testParameterFiles:
- /Velocyto-on10X-from-bundled-tests.yml
authors:
- name: Lucille Delisle
orcid: 0000-0002-1964-4960
- name: Velocyto-on10X-filtered-barcodes
subclass: Galaxy
publish: true
primaryDescriptorPath: /Velocyto-on10X-filtered-barcodes.ga
testParameterFiles:
- /Velocyto-on10X-filtered-barcodes-tests.yml
authors:
- name: Lucille Delisle
orcid: 0000-0002-1964-4960
5 changes: 5 additions & 0 deletions workflows/scRNAseq/velocyto/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Changelog

## [0.1] 2024-01-26

First release.
15 changes: 15 additions & 0 deletions workflows/scRNAseq/velocyto/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Velocyto on 10X data

These workflows simply run velocyto. There are 2 workflows because one can be easily run after the 'fastq-to-matrix-10x' workflows (Velocyto-on10X-from-bundled). The other can be easily run from uploaded datasets (Velocyto-on10X-filtered-barcodes).

## Input datasets

- BAM files with CB and UB: A collection of BAM. It accepts BAM from cellranger or STARsolo with the CB and UB tags (if you use the fastq-to-matrix-10x workflows these tags are automatically included).
- filtered barcodes (only for Velocyto_on10X_filtered_barcodes workflow): A collection of filtered barcodes (this is what will be used by velocyto). 'Filtered' means that these barcodes have been identified as potential cells. It should not be the whole list of 3 million possible barcodes from cellranger.
- filtered matrices in bundle (only for Velocyto_on10X_from_bundled workflow): A collection of filtered matrices as bundled (like the one which comes from the fastq-to-matrix-10x workflows): A collection with as many items as samples. For each sample, the item is a list with 3 datasets (barcodes, genes, matrix). The workflow will then extract the items which have the 'barcodes' identifier.
- gtf file: A file with annotations where exons are and how they are grouped into genes.

## Processing

- If you provided matrices, the first step is to extract barcodes.
- For both cases velocyto cli is run to get a loom file per sample with spliced and unspliced counts.
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
- doc: Test outline for Velocyto-on10X (barcodes)
job:
gtf file:
class: File
location: https://zenodo.org/record/6457007/files/Drosophila_melanogaster.BDGP6.32.109_UCSC.gtf.gz
decompress: true
filetype: gtf
BAM files with CB and UB:
class: Collection
collection_type: list
elements:
- class: File
identifier: subsample
location: https://zenodo.org/records/10572348/files/subsample.bam
filetype: bam
filtered barcodes:
class: Collection
collection_type: list
elements:
- class: File
identifier: subsample
location: https://zenodo.org/records/10572348/files/barcodes.tsv
filetype: tsv
outputs:
velocyto loom:
element_tests:
subsample:
asserts:
has_size:
value: 4639326
delta: 400000
178 changes: 178 additions & 0 deletions workflows/scRNAseq/velocyto/Velocyto-on10X-filtered-barcodes.ga
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
{
"a_galaxy_workflow": "true",
"annotation": "Run velocyto to get loom with counts of spliced and unspliced",
"comments": [],
"creator": [
{
"class": "Person",
"identifier": "https://orcid.org/0000-0002-1964-4960",
"name": "Lucille Delisle"
}
],
"format-version": "0.1",
"license": "MIT",
"release": "0.1",
"name": "Velocyto-on10X-filtered-barcodes",
"steps": {
"0": {
"annotation": "This can be output of CellRanger or STARsolo",
"content_id": null,
"errors": null,
"id": 0,
"input_connections": {},
"inputs": [
{
"description": "This can be output of CellRanger or STARsolo",
"name": "BAM files with CB and UB"
}
],
"label": "BAM files with CB and UB",
"name": "Input dataset collection",
"outputs": [],
"position": {
"left": 0,
"top": 0
},
"tool_id": null,
"tool_state": "{\"optional\": false, \"format\": [\"bam\"], \"tag\": \"\", \"collection_type\": \"list\"}",
"tool_version": null,
"type": "data_collection_input",
"uuid": "043d198b-3af0-477d-be11-5d1373280379",
"when": null,
"workflow_outputs": []
},
"1": {
"annotation": "This can be output of STARsolo or DropletUtils (too many barcodes will make memory errors)",
"content_id": null,
"errors": null,
"id": 1,
"input_connections": {},
"inputs": [
{
"description": "This can be output of STARsolo or DropletUtils (too many barcodes will make memory errors)",
"name": "filtered barcodes"
}
],
"label": "filtered barcodes",
"name": "Input dataset collection",
"outputs": [],
"position": {
"left": 55.999999999999986,
"top": 108.33333333333333
},
"tool_id": null,
"tool_state": "{\"optional\": false, \"format\": [\"tsv\"], \"tag\": \"\", \"collection_type\": \"list\"}",
"tool_version": null,
"type": "data_collection_input",
"uuid": "03b0d22c-3b46-4460-8c18-b524bc09d655",
"when": null,
"workflow_outputs": []
},
"2": {
"annotation": "gtf file",
"content_id": null,
"errors": null,
"id": 2,
"input_connections": {},
"inputs": [
{
"description": "gtf file",
"name": "gtf file"
}
],
"label": "gtf file",
"name": "Input dataset",
"outputs": [],
"position": {
"left": 148,
"top": 204.66666666666666
},
"tool_id": null,
"tool_state": "{\"optional\": false, \"format\": [\"gtf\"], \"tag\": \"\"}",
"tool_version": null,
"type": "data_input",
"uuid": "f1d04259-f449-44d7-8d36-49f3ad664361",
"when": null,
"workflow_outputs": []
},
"3": {
"annotation": "",
"content_id": "toolshed.g2.bx.psu.edu/repos/iuc/velocyto_cli/velocyto_cli/0.17.17+galaxy1",
"errors": null,
"id": 3,
"input_connections": {
"main|BAM": {
"id": 0,
"output_name": "output"
},
"main|barcodes": {
"id": 1,
"output_name": "output"
},
"main|gtffile": {
"id": 2,
"output_name": "output"
}
},
"inputs": [
{
"description": "runtime parameter for tool velocyto CLI",
"name": "main"
},
{
"description": "runtime parameter for tool velocyto CLI",
"name": "main"
},
{
"description": "runtime parameter for tool velocyto CLI",
"name": "main"
},
{
"description": "runtime parameter for tool velocyto CLI",
"name": "main"
},
{
"description": "runtime parameter for tool velocyto CLI",
"name": "main"
}
],
"label": "velocyto",
"name": "velocyto CLI",
"outputs": [
{
"name": "samples",
"type": "loom"
}
],
"position": {
"left": 470.66666666666663,
"top": 116.32222493489576
},
"post_job_actions": {},
"tool_id": "toolshed.g2.bx.psu.edu/repos/iuc/velocyto_cli/velocyto_cli/0.17.17+galaxy1",
"tool_shed_repository": {
"changeset_revision": "883c33ef3372",
"name": "velocyto_cli",
"owner": "iuc",
"tool_shed": "toolshed.g2.bx.psu.edu"
},
"tool_state": "{\"main\": {\"do\": \"run10x\", \"__current_case__\": 0, \"sample_definition\": {\"sample_definition_select\": \"identifier\", \"__current_case__\": 1}, \"BAM\": {\"__class__\": \"ConnectedValue\"}, \"barcodes\": {\"__class__\": \"ConnectedValue\"}, \"gtffile\": {\"__class__\": \"ConnectedValue\"}, \"s\": {\"__class__\": \"RuntimeValue\"}, \"m\": {\"__class__\": \"RuntimeValue\"}, \"M\": false, \"t\": \"uint16\"}, \"verbosity\": \"-vv\", \"__page__\": null, \"__rerun_remap_job_id__\": null}",
"tool_version": "0.17.17+galaxy1",
"type": "tool",
"uuid": "f9aef50f-b31d-44dd-aad6-fe4d520e3b1e",
"when": null,
"workflow_outputs": [
{
"label": "velocyto loom",
"output_name": "samples",
"uuid": "2899a85c-c198-436f-a409-9bfbdf90c95f"
}
]
}
},
"tags": [
"name:single-cell"
],
"uuid": "33862923-af05-48ba-aec5-14393981cee2",
"version": 4
}
43 changes: 43 additions & 0 deletions workflows/scRNAseq/velocyto/Velocyto-on10X-from-bundled-tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
- doc: Test outline for Velocyto-on10X (bundled)
job:
gtf file:
class: File
location: https://zenodo.org/record/6457007/files/Drosophila_melanogaster.BDGP6.32.109_UCSC.gtf.gz
decompress: true
filetype: gtf
BAM files with CB and UB:
class: Collection
collection_type: list
elements:
- class: File
identifier: subsample
location: https://zenodo.org/records/10572348/files/subsample.bam
filetype: bam
filtered matrices in bundle:
class: Collection
collection_type: list:list
elements:
- class: Collection
type: list
identifier: subsample
elements:
- class: File
identifier: barcodes
location: https://zenodo.org/records/10572348/files/barcodes.tsv
filetype: tsv
- class: File
identifier: genes
location: https://zenodo.org/records/10572348/files/genes.tsv
filetype: tsv
- class: File
identifier: matrix
location: https://zenodo.org/records/10572348/files/matrix.mtx
filetype: mtx
outputs:
velocyto loom:
element_tests:
subsample:
asserts:
has_size:
value: 4639326
delta: 400000
Loading

0 comments on commit ffd260f

Please sign in to comment.