Vignette(s)
Open
Nobody has claimed this yet.
documentation
- Dominant language
- R
- Stars
- 171
- Forks
- 26
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 3
Description
We don’t necessarily need it for the beta release, but just starting an issue to decide what content we should include in a vignette or several. I could imagine one long vignette or perhaps several smaller vignettes focused on separate things e.g. one about the formats and one about summaries and diagnostics, etc.).
Tentative list (add more items by editing this comment):
- Vignette demonstrating the different draws formats and manipulating them (e.g., subset, mutate, etc.)
- Vignette demonstrating summaries and diagnostics
- Vignette explaining how to interpret and use MCSEs (see also #44)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the vignette checklist in this issue and related issue #44 first. Agree on the vignette structure and content, then complete the unchecked MCSE vignette and update the checklist when the planned documentation is finished.
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
- Needs clarification
- Newbie friendliness
- 25/100