nmfs-ost / nmfs-ost/stockplotr
Find package improvements with `goodpractice` package
Open
Nobody has claimed this yet.
enhancement
NSAP-code-cleanup
- Dominant language
- R
- Stars
- 19
- Forks
- 7
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 9
Description
The goodpractice package gives "advice about good practices when building R packages. Advice includes functions and syntax to avoid, package structure, code complexity, code formatting, etc."
Steps:
- Install the
goodpracticeand stockplotr R packages
install.packages("pak")
pak::pak("goodpractice")
pak::pak("nmfs-ost/stockplotr")
- Find where the
stockplotrpackage is saved on your machine. This workflow should work:
# Find where your packages live
pkg_location <- .libPaths()
# Then find where stockplotr lives, specifically. It might be:
stockplotr_location <- fs::path(pkg_location, "stockplotr")
- Run
goodpractice
goodpractice::gp("stockplotr_location")
- Address the package's advice 🙂
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 by installing goodpractice and stockplotr, locate the installed stockplotr package, and run goodpractice::gp("stockplotr_location"). Review each reported recommendation in the stockplotr package, then rerun goodpractice to confirm the reported advice has been addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100