ScotGovAnalysis / ScotGovAnalysis/cssampling
Improve documentation
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 1
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Update repository description to allow users to assign values to the relevant objects and run the RAP.
Might also be worth having a more extensive guide, possibly something similar to a vignette, to facilitate handovers and code familiarisation?
Contributor guide
No contributing guide indexed for this repository
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 by reviewing the current repository description and the RAP usage flow. Identify which objects users must assign before running the RAP, then determine the scope of a handover or vignette-style guide. Done means a newcomer can configure the relevant objects, run the RAP, and follow the documentation without relying on project history.
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
- Needs clarification
- Newbie friendliness
- 25/100