Skip to content

Commit

Permalink
Fix violin
Browse files Browse the repository at this point in the history
Signed-off-by: zethson <[email protected]>
  • Loading branch information
Zethson committed Feb 7, 2024
1 parent cf10908 commit 1fdd3cc
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 12 deletions.
2 changes: 1 addition & 1 deletion bin/demuxem.py
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@
rna_data.X.data = np.log1p(rna_data.X.data)

for gene_name in args.generateGenderPlot:
demuxEM.plot_gene_violin(
io.violin(
rna_data,
gene_name,
"{output_name}.{gene_name}.violin.pdf".format(
Expand Down
20 changes: 9 additions & 11 deletions docs/source/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## **hadge: a comprehensive pipeline for donor deconvolution in single cell**

Preprint manuscript is available [here](https://www.biorxiv.org/content/10.1101/2023.07.23.550061v2)
A preprint is available [here](https://www.biorxiv.org/content/10.1101/2023.07.23.550061v2).

![Caption](_static/images/pipeline.png)

Expand All @@ -17,7 +17,7 @@ The mode of the pipeline is set by `params.mode`. hadge provides 4 modes in tota

## **Pipeline configuration**

The pipeline provides some pre-defined profiles. The standard profile is used by default when no profile is specified, where the pipeeline is run locall and all processes annotated with the big_mem label are assigned 4 cpus and 16 Gb of memory.
The pipeline provides some pre-defined profiles. The standard profile is used by default when no profile is specified, where the pipeline is run locally and all processes annotated with the big_mem label are assigned 4 cpus and 16 Gb of memory.

```
profiles{
Expand All @@ -37,9 +37,10 @@ profiles{
}
```

### Conda environments:
### Conda environments

By using the `-profile conda` option, the pipeline executes each process within a Conda environment specified in the conda directive. Alternatively, you have the flexibility to add a new profile in the `nextflow.config` file, allowing you to use local Conda environments for running processes.
By using the `-profile conda` option, the pipeline executes each process within a Conda environment specified in the conda directive.
Alternatively, you have the flexibility to add a new profile in the `nextflow.config` file, allowing you to use local Conda environments for running processes.

```
profiles{
Expand All @@ -64,7 +65,7 @@ profiles{
}
```

### Containers:
### Containers

Nextflow also supports a variety of container runtimes, e.g. Docker. To specify a different Docker image for each process:

Expand All @@ -77,20 +78,16 @@ profiles{
withName:foo {
container = 'image_name_1'
}
withName:bar {
container = 'image_name_2'
}
}
}
}
```

### Executor and resource specifications:
### Executor and resource specifications

- The pipeline can also be run on an HPC. You can set the executor by running the pipeline with `-profile cluster`.
- Feel free to add other configurations, e.g. the number of CPUS, the memory allocation, etc. If you are new to Nextflow framework, please visit the [Nextlfow page](https://www.nextflow.io/docs/latest/config.html#).

```
cluster {
Expand Down Expand Up @@ -123,7 +120,8 @@ nextflow run main.nf -profile standard,conda

### **Running on multiple samples**

The pipeline is able to run on multiple samples. In this scenario, the shared parameters for input data are retrieved from a sample sheet using `params.multi_sample`, which is set to None by default.
The pipeline is able to run on multiple samples.
In this scenario, the shared parameters for input data are retrieved from a sample sheet using `params.multi_sample`, which is set to None by default.
Along with the input data, the sample sheet should contain an additional column for unique sample IDs assigned to each sample. The remaining parameters for each process are specified in the nextflow.config file, just like when demultiplexing a single sample.
However, there is a distinction between running on a single sample and running on multiple samples. When processing multiple samples, the pipeline only permits a single value for each process parameter, whereas in the case of a single sample, multiple values separated by commas are allowed.
The sample sheet (example file see the Resources section below) should have e.g. following columns depending on the methods you want to run:
Expand Down

0 comments on commit 1fdd3cc

Please sign in to comment.