gagneurlab / gagneurlab/wBuild
Include header template in the documentation?
Open
low priority
- Dominant language
- Python
- Stars
- 4
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
I've noticed that through all the time that I use wBuild I pretty much use the same code template, including
```R
source('.wBuild/wBuildParser.R')
parseWBHeader("Scripts/SNPplot/Main/calcMean.R")
```
which was not that apparent at the beginning.
Contributor guide
Research direction
Start with .wBuild/wBuildParser.R and the parseWBHeader entry point shown in the issue, then locate the existing wBuild documentation. Document the recurring source and parseWBHeader template, including the example path, so users can find the basic header workflow without prior familiarity.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100