easystats / easystats/parameters
Reviewing existing articles
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 499
- Forks
- 45
- Avg merge
- 3d 1h
- Merged PRs (30d)
- 3
Description
Hi @jacob-long! 👋
Hope you are doing well.
We were wondering if it would be possible for you to review the existing articles?
https://easystats.github.io/parameters/articles/overview_of_vignettes.html
{parameters} has seen a phase of rapid development, but we haven't always been as prompt in updating the documentation, and have even become a bit "blind" to any inconsistencies that might exist in the docs. So it would be good to have a fresh pair of eyes review them.
We would also love to get some feedback on the current workflow surrounding {parameters} from you. Given your own extensive experience with regression analysis, we'd love to know if you find the package API easy/intuitive to use and if it provides all the functionality that you might need.
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 overview of vignettes at easystats.github.io/parameters/articles/overview_of_vignettes.html, then review the existing articles for inconsistencies. The issue also requests feedback on the {parameters} workflow, API intuitiveness, and missing regression-analysis functionality; the work is done when actionable documentation and API feedback has been recorded.
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
- 20/100