LDheatmap documentation revamp
Supervisor: Brad McNeney
LDheatmap is an R package written and maintained by the Statistical Genetics Working Group at SFU. In the 10 years since its publication on the Comprehensive R Archive Network (CRAN), LDheatmap has been cited in 139 research papers in fields such as agriculture and medicine. The documentation in the package is in need of an update. First, we have received numerous suggestions from users for clarifications to the existing documentation. Second, we would like to adopt state-of-the-art tools for maintaining documentation. The NSERC USRA will be responsible for
- Familiarizing themselves with the LDheatmap code and documentation,
- Assessing the suitability of modern R documentation systems, such as roxygen2, for the needs of the LDHeatmap project,
- Porting existing documentation to the new system, and
- Keeping notes to document all changes to the package.