Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Np multimapper param starsolo #1172

Merged
merged 35 commits into from
Jan 16, 2024
Merged
Show file tree
Hide file tree
Changes from 22 commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
4d8b21c
add summary task
nikellepetrillo Nov 16, 2023
f0c71c9
Merge remote-tracking branch 'origin/develop' into develop
nikellepetrillo Nov 21, 2023
5d6c00d
Merge remote-tracking branch 'origin/develop' into develop
nikellepetrillo Nov 29, 2023
2b65b6e
Merge remote-tracking branch 'origin/develop' into develop
nikellepetrillo Dec 4, 2023
294082c
Merge remote-tracking branch 'origin/develop' into develop
nikellepetrillo Dec 19, 2023
d439840
Merge remote-tracking branch 'origin/develop' into develop
nikellepetrillo Jan 4, 2024
1bb3595
Merge remote-tracking branch 'origin/develop' into develop
nikellepetrillo Jan 8, 2024
d503743
add multimapper option
nikellepetrillo Jan 8, 2024
693c932
update optimus plumbing for ease of testing
nikellepetrillo Jan 8, 2024
50b75ac
add echos
nikellepetrillo Jan 8, 2024
10b4248
add to test
nikellepetrillo Jan 8, 2024
b52cbf1
remove some echoes
nikellepetrillo Jan 9, 2024
1949d4e
make mouse snrna json go back to what is in dev
nikellepetrillo Jan 9, 2024
a330405
make mouse snrna json go back to what is in dev
nikellepetrillo Jan 9, 2024
e4d2fa2
add as outputs
nikellepetrillo Jan 9, 2024
e75a479
typo
nikellepetrillo Jan 10, 2024
1c6470c
Merge branch 'develop' into np_multipper_param_starsolo
nikellepetrillo Jan 11, 2024
bab93ad
changelogs
nikellepetrillo Jan 11, 2024
6274b61
Merge remote-tracking branch 'origin/np_multipper_param_starsolo' int…
nikellepetrillo Jan 11, 2024
3aeca87
changelogs
nikellepetrillo Jan 11, 2024
e8fde9f
changelogs
nikellepetrillo Jan 11, 2024
660c1ec
update pipeline docs
kayleemathews Jan 12, 2024
fc80cdb
optional output
nikellepetrillo Jan 12, 2024
bc5f00a
Merge remote-tracking branch 'origin/np_multipper_param_starsolo' int…
nikellepetrillo Jan 12, 2024
c008ee1
Merge branch 'develop' into np_multipper_param_starsolo
nikellepetrillo Jan 12, 2024
500ff51
optional output
nikellepetrillo Jan 12, 2024
f56e5da
Merge remote-tracking branch 'origin/np_multipper_param_starsolo' int…
nikellepetrillo Jan 12, 2024
e8d9111
optional output
nikellepetrillo Jan 12, 2024
875fa4a
optional output
nikellepetrillo Jan 12, 2024
5ce21a4
docs
nikellepetrillo Jan 12, 2024
a8223df
docs
nikellepetrillo Jan 12, 2024
21e8d37
docs
nikellepetrillo Jan 12, 2024
47a6197
Update website/docs/Pipelines/Optimus_Pipeline/README.md
nikellepetrillo Jan 16, 2024
e72f185
remove optional input to tests
nikellepetrillo Jan 16, 2024
f24bcef
Merge remote-tracking branch 'origin/np_multipper_param_starsolo' int…
nikellepetrillo Jan 16, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions pipelines/skylab/multiome/Multiome.changelog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# 3.0.5
2024-01-11 (Date of Last Commit)

* Added the --soloMultiMappers flag as an optional input to the StarSoloFastq task in the StarAlign.wdl

# 3.0.4
2024-01-05 (Date of Last Commit)

Expand Down
9 changes: 8 additions & 1 deletion pipelines/skylab/multiome/Multiome.wdl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import "../../../tasks/skylab/H5adUtils.wdl" as H5adUtils
import "https://raw.githubusercontent.com/broadinstitute/CellBender/v0.3.0/wdl/cellbender_remove_background.wdl" as CellBender

workflow Multiome {
String pipeline_version = "3.0.4"
String pipeline_version = "3.0.5"

input {
String input_id
Expand All @@ -27,6 +27,7 @@ workflow Multiome {
String star_strand_mode = "Forward"
Boolean count_exons = false
File gex_whitelist = "gs://gcp-public-data--broad-references/RNA/resources/arc-v1/737K-arc-v1_gex.txt"
String? soloMultiMappers

# ATAC inputs
# Array of input fastq files
Expand Down Expand Up @@ -67,6 +68,7 @@ workflow Multiome {
ignore_r1_read_length = ignore_r1_read_length,
star_strand_mode = star_strand_mode,
count_exons = count_exons,
soloMultiMappers = soloMultiMappers
}

# Call the ATAC workflow
Expand Down Expand Up @@ -134,6 +136,11 @@ workflow Multiome {
File gene_metrics_gex = Optimus.gene_metrics
File? cell_calls_gex = Optimus.cell_calls
File h5ad_output_file_gex = JoinBarcodes.gex_h5ad_file
Array[File] soloMultiMappers = Optimus.soloMultiMappers
Array[File?] multimappers_EM_matrix = Optimus.multimappers_EM_matrix
Array[File?] multimappers_Uniform_matrix = Optimus.multimappers_Uniform_matrix
Array[File?] multimappers_Rescue_matrix = Optimus.multimappers_Rescue_matrix
Array[File?] multimappers_PropUnique_matrix = Optimus.multimappers_PropUnique_matrix

# cellbender outputs
File? cell_barcodes_csv = CellBender.cell_csv
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,6 @@
"Multiome.run_cellbender":"false",
"Multiome.Atac.BWAPairedEndAlignment.cpu_platform":"Intel Cascade Lake",
"Multiome.Atac.BWAPairedEndAlignment.mem_size":"64",
"Multiome.Atac.BWAPairedEndAlignment.nthreads":"16"
"Multiome.Atac.BWAPairedEndAlignment.nthreads":"16",
"Multiome.soloMultiMappers":"Uniform"
}
4 changes: 4 additions & 0 deletions pipelines/skylab/optimus/Optimus.changelog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# 6.3.4
2024-01-11 (Date of Last Commit)
* Added the --soloMultiMappers flag as an optional input to the StarSoloFastq task in the StarAlign.wdl

# 6.3.3
2024-01-05 (Date of Last Commit)
* Modified the STARsoloFastq task in the StarAlign.wdl so STARsolo can run different types of alignments in a single STARsolo command depending on the counting_mode
Expand Down
12 changes: 10 additions & 2 deletions pipelines/skylab/optimus/Optimus.wdl
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ workflow Optimus {
File annotations_gtf
File ref_genome_fasta
File? mt_genes
String? soloMultiMappers

# Chemistry options include: 2 or 3
Int tenx_chemistry_version
Expand Down Expand Up @@ -64,7 +65,7 @@ workflow Optimus {

# version of this pipeline

String pipeline_version = "6.3.3"
String pipeline_version = "6.3.4"

# this is used to scatter matched [r1_fastq, r2_fastq, i1_fastq] arrays
Array[Int] indices = range(length(r1_fastq))
Expand Down Expand Up @@ -131,7 +132,8 @@ workflow Optimus {
chemistry = tenx_chemistry_version,
counting_mode = counting_mode,
count_exons = count_exons,
output_bam_basename = output_bam_basename + "_" + idx
output_bam_basename = output_bam_basename + "_" + idx,
soloMultiMappers = soloMultiMappers
}
}
call Merge.MergeSortBamFiles as MergeBam {
Expand Down Expand Up @@ -237,6 +239,12 @@ workflow Optimus {
File gene_metrics = GeneMetrics.gene_metrics
File? cell_calls = RunEmptyDrops.empty_drops_result
File? aligner_metrics = MergeStarOutputs.cell_reads_out
Array[File] soloMultiMappers = STARsoloFastq.matrix_sn_rna
Copy link
Contributor

@ekiernan ekiernan Jan 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this output supposed to be optional?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dont think so, because we do a touch matrix_sn_rna.mtx in the starsolofastq command, so we will always capture this as an output, even if it is empty

Array[File?] multimappers_EM_matrix = STARsoloFastq.multimappers_EM_matrix
Array[File?] multimappers_Uniform_matrix = STARsoloFastq.multimappers_Uniform_matrix
Array[File?] multimappers_Rescue_matrix = STARsoloFastq.multimappers_Rescue_matrix
Array[File?] multimappers_PropUnique_matrix = STARsoloFastq.multimappers_PropUnique_matrix

# h5ad
File h5ad_output_file = final_h5ad_output
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,6 @@
"Optimus.tenx_chemistry_version": "3",
"Optimus.annotations_gtf": "gs://gcp-public-data--broad-references/hg38/v0/star/v2_7_10a/modified_v43.annotation.gtf",
"Optimus.star_strand_mode": "Forward",
"Optimus.ref_genome_fasta": "gs://gcp-public-data--broad-references/hg38/v0/GRCh38.primary_assembly.genome.fa"
"Optimus.ref_genome_fasta": "gs://gcp-public-data--broad-references/hg38/v0/GRCh38.primary_assembly.genome.fa",
"Optimus.soloMultiMappers": "EM"
}
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,6 @@
"Optimus.tenx_chemistry_version": "2",
"Optimus.star_strand_mode": "Unstranded",
"Optimus.annotations_gtf": "gs://gcp-public-data--broad-references/GRCm39/star/v2_7_10a/modified_vM32.annotation.gtf",
"Optimus.ref_genome_fasta": "gs://gcp-public-data--broad-references/GRCm39/GRCm39.primary_assembly.genome.fa.gz"
"Optimus.ref_genome_fasta": "gs://gcp-public-data--broad-references/GRCm39/GRCm39.primary_assembly.genome.fa.gz",
"Optimus.soloMultiMappers": "EM"
}
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,6 @@
"Optimus.annotations_gtf": "gs://gcp-public-data--broad-references/GRCm39/star/v2_7_10a/modified_vM32.annotation.gtf",
"Optimus.ref_genome_fasta": "gs://gcp-public-data--broad-references/GRCm39/GRCm39.primary_assembly.genome.fa.gz",
"Optimus.counting_mode": "sn_rna",
"Optimus.count_exons": true
"Optimus.count_exons": true,
"Optimus.soloMultiMappers": "EM"
}
4 changes: 4 additions & 0 deletions pipelines/skylab/paired_tag/PairedTag.changelog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# 0.0.4
2024-01-11 (Date of Last Commit)
* Added the --soloMultiMappers flag as an optional input to the StarSoloFastq task in the StarAlign.wdl

# 0.0.3
2024-01-05 (Date of Last Commit)

Expand Down
2 changes: 1 addition & 1 deletion pipelines/skylab/paired_tag/PairedTag.wdl
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import "../../../pipelines/skylab/optimus/Optimus.wdl" as optimus
import "../../../tasks/skylab/H5adUtils.wdl" as H5adUtils
import "../../../tasks/skylab/PairedTagUtils.wdl" as Demultiplexing
workflow PairedTag {
String pipeline_version = "0.0.3"
String pipeline_version = "0.0.4"

input {
String input_id
Expand Down
4 changes: 4 additions & 0 deletions pipelines/skylab/slideseq/SlideSeq.changelog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# 2.1.5
2024-01-11 (Date of Last Commit)
* Added the --soloMultiMappers flag as an optional input to the StarSoloFastq task in the StarAlign.wdl; this does affect the SlideSeq workflow

# 2.1.4
2024-01-05 (Date of Last Commit)
* Modified the STARsoloFastq task in the StarAlign.wdl so STARsolo can run different types of alignments in a single STARsolo command depending on the counting_mode; this does affect the SlideSeq workflow
Expand Down
2 changes: 1 addition & 1 deletion pipelines/skylab/slideseq/SlideSeq.wdl
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import "../../../tasks/skylab/MergeSortBam.wdl" as Merge

workflow SlideSeq {

String pipeline_version = "2.1.4"
String pipeline_version = "2.1.5"

input {
Array[File] r1_fastq
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# 1.2.28
2024-01-11 (Date of Last Commit)
* Added the --soloMultiMappers flag as an optional input to the StarSoloFastq task in the StarAlign.wdl; this does affect the MultiSampleSmartSeq2SingleNucleus workflow

# 1.2.27
2024-01-05 (Date of Last Commit)
* Modified the STARsoloFastq task in the StarAlign.wdl so STARsolo can run different types of alignments in a single STARsolo command depending on the counting_mode; this does affect the MultiSampleSmartSeq2SingleNucleus workflow
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ workflow MultiSampleSmartSeq2SingleNucleus {
String? input_id_metadata_field
}
# Version of this pipeline
String pipeline_version = "1.2.27"
String pipeline_version = "1.2.28"

if (false) {
String? none = "None"
Expand Down
38 changes: 28 additions & 10 deletions tasks/skylab/StarAlign.wdl
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,7 @@ task STARsoloFastq {
String counting_mode # when counting_mode = sn_rna, runs Gene and GeneFullEx50pAS in single alignments
String output_bam_basename
Boolean? count_exons
String? soloMultiMappers

# runtime values
String docker = "us.gcr.io/broad-gotc-prod/star:1.0.1-2.7.11a-1692706072"
Expand Down Expand Up @@ -308,7 +309,8 @@ task STARsoloFastq {
--outSAMtype BAM SortedByCoordinate \
--outSAMattributes UB UR UY CR CB CY NH GX GN sF \
--soloBarcodeReadLength 0 \
--soloCellReadStats Standard
--soloCellReadStats Standard \
~{"--soloMultiMappers " + soloMultiMappers}
elif [[ "~{counting_mode}" == "sn_rna" ]]
then
## single nuclei
Expand All @@ -333,7 +335,8 @@ task STARsoloFastq {
--outSAMtype BAM SortedByCoordinate \
--outSAMattributes UB UR UY CR CB CY NH GX GN sF \
--soloBarcodeReadLength 0 \
--soloCellReadStats Standard
--soloCellReadStats Standard \
~{"--soloMultiMappers " + soloMultiMappers}
else
COUNTING_MODE="GeneFull_Ex50pAS Gene"
echo "Running in ~{counting_mode} mode. Count_exons is true and the Star parameter --soloFeatures will be set to $COUNTING_MODE"
Expand All @@ -354,16 +357,14 @@ task STARsoloFastq {
--outSAMtype BAM SortedByCoordinate \
--outSAMattributes UB UR UY CR CB CY NH GX GN sF \
--soloBarcodeReadLength 0 \
--soloCellReadStats Standard
--soloCellReadStats Standard \
~{"--soloMultiMappers " + soloMultiMappers}
fi
else
echo Error: unknown counting mode: "$counting_mode". Should be either sn_rna or sc_rna.
exit 1;
fi




echo "UMI LEN " $UMILen

touch barcodes_sn_rna.tsv
Expand All @@ -377,9 +378,12 @@ task STARsoloFastq {

if [[ "~{counting_mode}" == "sc_rna" ]]
then
SoloDirectory="Solo.out/Gene/raw"
echo "SoloDirectory is $SoloDirectory"
find "$SoloDirectory" -maxdepth 1 -type f -name "*.mtx" -print0 | xargs -0 -I{} echo mv {} /cromwell_root/
find "$SoloDirectory" -maxdepth 1 -type f -name "*.mtx" -print0 | xargs -0 -I{} mv {} /cromwell_root/
mv "Solo.out/Gene/raw/barcodes.tsv" barcodes.tsv
mv "Solo.out/Gene/raw/features.tsv" features.tsv
mv "Solo.out/Gene/raw/matrix.mtx" matrix.mtx
mv "Solo.out/Gene/CellReads.stats" CellReads.stats
mv "Solo.out/Gene/Features.stats" Features.stats
mv "Solo.out/Gene/Summary.csv" Summary.csv
Expand All @@ -388,24 +392,34 @@ task STARsoloFastq {
then
if [[ "~{count_exons}" == "false" ]]
then
SoloDirectory="Solo.out/GeneFull_Ex50pAS/raw"
echo "SoloDirectory is $SoloDirectory"
find "$SoloDirectory" -maxdepth 1 -type f -name "*.mtx" -print0 | xargs -0 -I{} echo mv {} /cromwell_root/
find "$SoloDirectory" -maxdepth 1 -type f -name "*.mtx" -print0 | xargs -0 -I{} mv {} /cromwell_root/
mv "Solo.out/GeneFull_Ex50pAS/raw/barcodes.tsv" barcodes.tsv
mv "Solo.out/GeneFull_Ex50pAS/raw/features.tsv" features.tsv
mv "Solo.out/GeneFull_Ex50pAS/raw/matrix.mtx" matrix.mtx
mv "Solo.out/GeneFull_Ex50pAS/CellReads.stats" CellReads.stats
mv "Solo.out/GeneFull_Ex50pAS/Features.stats" Features.stats
mv "Solo.out/GeneFull_Ex50pAS/Summary.csv" Summary.csv
mv "Solo.out/GeneFull_Ex50pAS/UMIperCellSorted.txt" UMIperCellSorted.txt
else
SoloDirectory="Solo.out/GeneFull_Ex50pAS/raw"
echo "SoloDirectory is $SoloDirectory"
find "$SoloDirectory" -maxdepth 1 -type f -name "*.mtx" -print0 | xargs -0 -I{} echo mv {} /cromwell_root/
find "$SoloDirectory" -maxdepth 1 -type f -name "*.mtx" -print0 | xargs -0 -I{} mv {} /cromwell_root/
SoloDirectory="Solo.out/Gene/raw"
echo "SoloDirectory is $SoloDirectory"
find "$SoloDirectory" -maxdepth 1 -type f -name "*.mtx" -print0 | xargs -0 -I{} sh -c 'new_name="$(basename {} .mtx)_sn_rna.mtx"; echo mv {} "/cromwell_root/$new_name"'
find "$SoloDirectory" -maxdepth 1 -type f -name "*.mtx" -print0 | xargs -0 -I{} sh -c 'new_name="$(basename {} .mtx)_sn_rna.mtx"; mv {} "/cromwell_root/$new_name"'
mv "Solo.out/GeneFull_Ex50pAS/raw/barcodes.tsv" barcodes.tsv
mv "Solo.out/GeneFull_Ex50pAS/raw/features.tsv" features.tsv
mv "Solo.out/GeneFull_Ex50pAS/raw/matrix.mtx" matrix.mtx
mv "Solo.out/GeneFull_Ex50pAS/CellReads.stats" CellReads.stats
mv "Solo.out/GeneFull_Ex50pAS/Features.stats" Features.stats
mv "Solo.out/GeneFull_Ex50pAS/Summary.csv" Summary.csv
mv "Solo.out/GeneFull_Ex50pAS/UMIperCellSorted.txt" UMIperCellSorted.txt
mv "Solo.out/Gene/raw/barcodes.tsv" barcodes_sn_rna.tsv
mv "Solo.out/Gene/raw/features.tsv" features_sn_rna.tsv
mv "Solo.out/Gene/raw/matrix.mtx" matrix_sn_rna.mtx
#mv "Solo.out/Gene/raw/matrix.mtx" matrix_sn_rna.mtx
mv "Solo.out/Gene/CellReads.stats" CellReads_sn_rna.stats
mv "Solo.out/Gene/Features.stats" Features_sn_rna.stats
mv "Solo.out/Gene/Summary.csv" Summary_sn_rna.csv
Expand Down Expand Up @@ -445,6 +459,10 @@ task STARsoloFastq {
File align_features_sn_rna = "Features_sn_rna.stats"
File summary_sn_rna = "Summary_sn_rna.csv"
File umipercell_sn_rna = "UMIperCellSorted_sn_rna.txt"
File? multimappers_EM_matrix = "UniqueAndMult-EM.mtx"
File? multimappers_Uniform_matrix = "UniqueAndMult-Uniform.mtx"
File? multimappers_Rescue_matrix = "UniqueAndMult-Rescue.mtx"
File? multimappers_PropUnique_matrix = "UniqueAndMult-PropUnique.mtx"
}
}

Expand Down
4 changes: 3 additions & 1 deletion verification/test-wdls/TestMultiome.wdl
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ workflow TestMultiome {
String star_strand_mode = "Forward"
Boolean count_exons = false
File gex_whitelist = "gs://broad-gotc-test-storage/Multiome/input/737K-arc-v1_gex.txt"
String? soloMultiMappers

# ATAC inputs
# Array of input fastq files
Expand Down Expand Up @@ -84,7 +85,8 @@ workflow TestMultiome {
adapter_seq_read3 = adapter_seq_read3,
chrom_sizes = chrom_sizes,
atac_whitelist = atac_whitelist,
run_cellbender = run_cellbender
run_cellbender = run_cellbender,
soloMultiMappers = soloMultiMappers

}

Expand Down
4 changes: 3 additions & 1 deletion verification/test-wdls/TestOptimus.wdl
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ workflow TestOptimus {
File annotations_gtf
File ref_genome_fasta
File? mt_genes
String? soloMultiMappers

# Chemistry options include: 2 or 3
Int tenx_chemistry_version = 2
Expand Down Expand Up @@ -84,7 +85,8 @@ workflow TestOptimus {
force_no_check = force_no_check,
star_strand_mode = star_strand_mode,
count_exons = count_exons,
ignore_r1_read_length = ignore_r1_read_length
ignore_r1_read_length = ignore_r1_read_length,
soloMultiMappers = soloMultiMappers
}

# Collect all of the pipeling output into single Array
Expand Down
8 changes: 7 additions & 1 deletion website/docs/Pipelines/Multiome_Pipeline/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ slug: /Pipelines/Multiome_Pipeline/README

| Pipeline Version | Date Updated | Documentation Author | Questions or Feedback |
| :----: | :---: | :----: | :--------------: |
| [Multiome v3.0.4](https://github.com/broadinstitute/warp/releases) | January, 2024 | Kaylee Mathews | Please file GitHub issues in warp or contact the [WARP Pipeline Development team](mailto:warp-pipelines-help@broadinstitute.org) |
| [Multiome v3.0.5](https://github.com/broadinstitute/warp/releases) | January, 2024 | Kaylee Mathews | Please file GitHub issues in warp or contact the [WARP Pipeline Development team](mailto:warp-pipelines-help@broadinstitute.org) |

![Multiome_diagram](./multiome_diagram.png)

Expand Down Expand Up @@ -70,6 +70,7 @@ Multiome can be deployed using [Cromwell](https://cromwell.readthedocs.io/en/sta
| star_strand_mode | Optional string for the Optimus (GEX) pipeline for performing STARsolo alignment on forward stranded, reverse stranded, or unstranded data; default is "Forward". | String |
| count_exons | Optional boolean for the Optimus (GEX) pipeline indicating if the workflow should calculate exon counts **when in single-nucleus (sn_rna) mode**; if "true" in sc_rna mode, the workflow will return an error; default is "false". | Boolean |
| gex_whitelist | Optional file containing the list of valid barcodes for 10x multiome GEX data; default is "gs://gcp-public-data--broad-references/RNA/resources/arc-v1/737K-arc-v1_gex.txt". | File |
| soloMultiMappers | Optional string describing whether or not the Optimus (GEX) pipeline should run STARsolo with the `--soloMultiMappers` flag. | String |
| atac_r1_fastq | Array of read 1 paired-end FASTQ files representing a single 10x multiome ATAC library. | Array[File] |
| atac_r2_fastq | Array of barcodes FASTQ files representing a single 10x multiome ATAC library. | Array[File] |
| atac_r3_fastq | Array of read 2 paired-end FASTQ files representing a single 10x multiome ATAC library. | Array[File] |
Expand Down Expand Up @@ -114,6 +115,11 @@ The Multiome workflow calls two WARP subworkflows, one external subworkflow (opt
| gene_metrics_gex | `<input_id>_gex.gene_metrics.csv.gz` | CSV file containing the per-gene metrics. |
| cell_calls_gex | `<input_id>_gex.emptyDrops` | TSV file containing the EmptyDrops results when the Optimus workflow is run in sc_rna mode. |
| h5ad_output_file_gex | `<input_id>_gex.h5ad` | h5ad (Anndata) file containing the raw cell-by-gene count matrix, gene metrics, cell metrics, and global attributes. Also contains equivalent ATAC barcode for each gene expression barcode in the `atac_barcodes` column of the `h5ad.obs` property. See the [Optimus Count Matrix Overview](../Optimus_Pipeline/Loom_schema.md) for more details. |
| soloMultiMappers |
| multimappers_EM_matrix |
| multimappers_Uniform_matrix |
| multimappers_Rescue_matrix |
| multimappers_PropUnique_matrix |
| cell_barcodes_csv | `<cell_csv>` | Optional output produced when `run_cellbender` is "true"; see CellBender [documentation](https://cellbender.readthedocs.io/en/latest/usage/index.html) and [GitHub repository](https://github.com/broadinstitute/CellBender/tree/master) for more information. |
| checkpoint_file | `<ckpt_file>` | Optional output produced when `run_cellbender` is "true"; see CellBender [documentation](https://cellbender.readthedocs.io/en/latest/usage/index.html) and [GitHub repository](https://github.com/broadinstitute/CellBender/tree/master) for more information. |
| h5_array | `<h5_array>` | Optional output produced when `run_cellbender` is "true"; see CellBender [documentation](https://cellbender.readthedocs.io/en/latest/usage/index.html) and [GitHub repository](https://github.com/broadinstitute/CellBender/tree/master) for more information. |
Expand Down
Loading