Skip to content

Commit

Permalink
Added optional params to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kbestak committed Nov 10, 2023
1 parent 0635f33 commit 28dbee7
Showing 1 changed file with 33 additions and 3 deletions.
36 changes: 33 additions & 3 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,39 @@ nextflow run nf-core/molkart -profile docker -params-file params.yaml
with `params.yaml` containing:

```yaml
input: './samplesheet.csv'
outdir: './results/'
<...>
input: "./samplesheet.csv"
outdir: "./results/"
```
Additionally, `params.yaml` can contain optional parameters:

```yaml
input: "./samplesheet.csv"
outdir: "./results/"
segmentation_method: "mesmer"
cellpose_save_flows: false
cellpose_diameter: 30
cellpose_chan: 0
cellpose_chan2: null
cellpose_pretrained_model: "cyto"
cellpose_custom_model: null
cellpose_flow_threshold: 0.4
cellpose_edge_exclude: true
mesmer_image_mpp: 0.138
mesmer_compartment: "whole-cell"
ilastik_pixel_project: null
ilastik_multicut_project: null
tilesize: 2144
skip_clahe: false
clahe_cliplimit: 0.01
clahe_nbins: 256
clahe_pixel_size: 0.138
clahe_kernel: 25
create_training_subset: false
crop_amount: 4
crop_nonzero_fraction: 0.4
crop_size_x: 400
crop_size_y: 400
```

You can also generate such `YAML`/`JSON` files via [nf-core/launch](https://nf-co.re/launch).
Expand Down

0 comments on commit 28dbee7

Please sign in to comment.