easystats / easystats/easystats
Should we leave out `date` and `author` from vignette metadata?
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 1.2k
- Forks
- 88
- PR merge metrics
- No merged PRs in 30d
Description
We often include this metadata in our vignettes:
https://github.com/search?q=org%3Aeasystats+%22date%3A%22+language%3ARMarkdown&type=code&l=RMarkdown
But, supposedly, including them is not ideal or necessary. TBH, we don't need to include author metadata because most of our vignettes start out with how to cite them, and the citation itself contains the author details.
Ref: https://r-pkgs.org/vignettes.html#metadata
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
Start with the linked GitHub code search for easystats RMarkdown vignettes and compare their date and author metadata with the metadata guidance in r-pkgs.org/vignettes.html#metadata. Confirm the intended policy, then update the affected vignette files consistently; done means unnecessary metadata is removed without disrupting citation information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100