khanlab / khanlab/snakebids

Document the availability of `workflow.basedir` and `workflow.current_basedir`

Open
#109 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
23
Forks
16
PR merge metrics
No merged PRs in 30d

Description

As a followup to #102, Snakemake offers a few properties to access the app root directory. This is useful for getting resources etc stored in the app dir, as Snakebids apps often have their data in a different working directory than the app dir, so relative file paths don't work. The presence of these properties is not well documented in the Snakemake docs, but given their special relevance to Snakebids projects, it would be appropriate to give them special mention in our own docs.

Contributor guide

No contributing guide indexed for this repository

Research direction

No documentation file or test is named in the issue. Start by locating the project documentation and existing references to Snakemake workflow properties; document the availability and purpose of workflow.basedir and workflow.current_basedir, including their relevance when resources are outside the working directory.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.