klmr / klmr/box

Update wiki/paper

Open
#138 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
R
Stars
979
Forks
49
PR merge metrics
No merged PRs in 30d

Description

Coalesce the Wiki into a coherent document that can be generated via a vignette, and which serves as a blueprint of a potential paper (which obviously needs to be a drastically shortened version).

Points to address in a paper:

* [ ] Reproducibility (Jupyter, RMarkdown …) vs reusability
* [ ] Code modularisation
* [ ] Typing and use of NSE

Contributor guide

Open the contributing guide

Research direction

Start by reading the existing Wiki and determining how its content should be organized into a vignette. Use the checklist as the acceptance criteria: cover reproducibility versus reusability, code modularisation, and typing and NSE, while producing a coherent document that can serve as a shortened paper blueprint.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.