Skip to content

Commit 59a2dcd

Browse files
committed
update docs
1 parent 2915481 commit 59a2dcd

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

config/README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ You need one configuration file to configure the analyses and one annotation fil
44

55
- project configuration (`config/config.yaml`): Different for every project and configures the analyses to be performed.
66
- sample annotation (annotation): CSV file consisting of four mandatory columns.
7-
- name: A unique name of the dataset (tip: keep it short but descriptive).
8-
- data: Path to the tabular data as comma separated table (CSV).
9-
- metadata: Path to the metadata as comma separated table (CSV) with the first column being the index/identifier of each observation/sample and every other column metadata for the respective observation (either numeric or categorical, not mixed). **No NaN or empty values allowed.**
7+
- name: A unique name for the dataset (tip: keep it short but descriptive).
8+
- data: Path to the tabular data as a comma-separated table (CSV).
9+
- metadata: Path to the metadata as a comma-separated table (CSV) with the first column being the index/identifier of each observation/sample and every other column metadata for the respective observation (either numeric or categorical, not mixed). **No NaN or empty values allowed.**
1010
- samples_by_features: Boolean indicator if the data matrix is observations/samples (rows) x features (columns): 0==no, 1==yes.
11+
12+
Specify workflow-specific `resources` or command line arguments (CLI) in the workflow profile `workflow/profiles/default.config.yaml`, which supersedes global Snakemake profiles.

workflow/Snakefile

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import pandas as pd
88
import yaml
99
from snakemake.utils import min_version
1010

11+
##### set minimum Snakemake version #####
1112
min_version("8.20.1")
1213

1314
##### module name #####

0 commit comments

Comments
 (0)