Skip to content

Commit

Permalink
Fix Basic Visium Workflow (#125)
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffquinn-msk authored Oct 10, 2023
1 parent 587bf5c commit 85ced11
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 20 deletions.
26 changes: 7 additions & 19 deletions docs/nextflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,18 @@
Nextflow
========

BayesTME provides a nextflow workflow for running the entire pipeline
BayesTME provides a nextflow workflow for running a basic analysis on a Visium 10x dataset.

The only requirements for running the BayesTME nextflow pipeline locally are to install nextflow
(https://www.nextflow.io/docs/latest/getstarted.html) and docker.

The parameters template is defined in ``nextflow/nextflow.config``.

You can create a yaml file that defines the parameters for your run. This yaml file might look like this:

.. code::
spaceranger_dir: /path/to/spaceranger/outs
outdir: /path/to/results
seed: 42
inference_type: "SVI"
Once you have your parameters file ready, you can execute the pipeline with the following
command:
(https://www.nextflow.io/docs/latest/getstarted.html) and docker (or singularity).

.. code::
nextflow run https://github.com/tansey-lab/bayestme -r main -profile local -params-file '<path to params yaml>'
nextflow run main.nf -profile docker --input <path to spaceranger output> --n_cell_types 5 --outdir <output dir>
The results will be in the ``outdir`` directory specified in the params file, and will include raw
The results will be in the ``outdir`` directory specified in the params file, and will include
data and plots.

For more complicated workflows, see `./nextflow/modules` and `./nextflow/subworkflows` for composable components
that can be reused to author new pipelines.
2 changes: 1 addition & 1 deletion main.nf
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ workflow {
BAYESTME_BASIC_VISIUM_ANALYSIS(
Channel.fromList( [tuple([id: "sample", single_end: false],
file(params.input),
params.n_components) ])
params.n_cell_types) ])
)
}

0 comments on commit 85ced11

Please sign in to comment.