| Criteria | Improvable | OK | Good | Great |
|---|---|---|---|---|
| Presentation | No sticker. No badges. No GitHub Actions. README is sparse and illegible | No sticker. R-CMD-check badge is failing. README doesn’t explain what the package does or how it can be useful. | README conveys some information about the package. | Sticker is fabulous. Badges are informative. README is easy-to-read and full of useful, accessible information about the package. |
| Functionality | Very limited functionality provided by package. | Package is entirely data. | Package is mostly data with a couple of simple functions. | Package provides useful functions with data that support their use. |
| Testing | No tests. | A couple of trivial tests. | A handful of tests, at least some of which test function behavior. | Extensive suite of tests that check function behavior. |
Package
Package Proposal
- Open an Issue in our class repository. Describe your idea for a package. Be sure to tag your fellow group members.
- I will provide feedback and we will continue the conversation until we agree on an idea.
- You must open an Issue on GitHub by Friday, November 8, 5 pm!
Minimum Viable Project
- Write a minimally viable R package that contains at least one fully-documented function OR data set. Your package must:
- be in its own repository
- have all group members with at least one commit to the repo
- have a
README - install via
remotes::install_github() - pass
R CMD check(no errors, no warnings, minimal notes) - depend on at least one existing CRAN package
- have at least one test (e.g.
devtools::test())
- could be part of your pull request
- could be inspired by another class or project
- could be a new function that you just wrote
- Your MVP is due by Tuesday, November 19!
Important
You may NOT use generative AI tools to write the code for your package You may use generative AI tools to help with documentation and examples.
Completed Package
- Complete the R package. Your package must:
- meet all the requirements listed above for the MVP, plus
- have tests
- pass
R CMD checkboth locally and via GitHub Actions - have at least one dependency on an existing CRAN package
- have closed out all issues in the current milestone
- If you want to go further:
- create a hex sticker and put it on the README!
- have a vignette or tutorial
- have a
pkgdownsite!
- Your package is due by Tuesday, December 17!
- Tag me (
@beanumber) on an Issue on GitHub when you are done!
Package criteria
Project archive
These packages all began as SDS 270 projects.
| semester | badge | repo |
|---|---|---|
| s22 | zyang2k/bluebike | |
| s22 | rporta23/censusviz | |
| s22 | arrismo/criterioncollection | |
| s22 | amutaya/easyrbi | |
| s22 | rwu08/opensear | |
| s22 | katelyndiaz/ggRtsy | |
| s22 | Swaha294/ipl | |
| s22 | statsmed-sheep/medapps2021 | |
| s22 | kbruncati/diviiproject | |
| s22 | mflesaker/olympicmarathon | |
| s22 | sds270-s22/olympics | |
| s22 | sds270-s22/ftirsr | |
| s22 | abbidabbers/pokemon | |
| s22 | ajhaller/IPEDS | |
| s22 | vivala1/readUCI | |
| s22 | q-w-a/regulationsgov | |
| f19 | adror1/nwslR | |
| f19 | ranawg/fec16 | |
| f19 | abarylsky/dyadr | |
| f19 | jkeast/wikitablr | |
| f19 | sds390-f19/map_safe | |
| f19 | aballou16/geneticriskR | |
| f19 | kvanallen/deuce | |
| f19 | jormacmoo/shipcapcrew | |
| f19 | sunniraleigh/schoolR | |
| f19 | emmal73/readUCI | |
| f19 | danicamiguel/emetricsrsw |