Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sreichl committed Sep 12, 2024
1 parent 2915481 commit 59a2dcd
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
8 changes: 5 additions & 3 deletions config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ You need one configuration file to configure the analyses and one annotation fil

- project configuration (`config/config.yaml`): Different for every project and configures the analyses to be performed.
- sample annotation (annotation): CSV file consisting of four mandatory columns.
- name: A unique name of the dataset (tip: keep it short but descriptive).
- data: Path to the tabular data as comma separated table (CSV).
- 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.**
- name: A unique name for the dataset (tip: keep it short but descriptive).
- data: Path to the tabular data as a comma-separated table (CSV).
- 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.**
- samples_by_features: Boolean indicator if the data matrix is observations/samples (rows) x features (columns): 0==no, 1==yes.

Specify workflow-specific `resources` or command line arguments (CLI) in the workflow profile `workflow/profiles/default.config.yaml`, which supersedes global Snakemake profiles.
1 change: 1 addition & 0 deletions workflow/Snakefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import pandas as pd
import yaml
from snakemake.utils import min_version

##### set minimum Snakemake version #####
min_version("8.20.1")

##### module name #####
Expand Down

0 comments on commit 59a2dcd

Please sign in to comment.