slu-opengis / stlcsb Goto Github PK

Functions and unit testing:

• Fix csb_missingXY so that it no longer relies on options(scipen)
• Move magritter dependency to dplyr - update all @importFrom statements accordingly
• Add code to ensure each function returns a tibble to all functions that could be used post data download
• Remove csb_intersection()
• Update error messages to make them more informative for all functions
• Update unit testing to reflect new error messages, tibble return
• Make sure all unit tests use january_2018
• Make sure unit tests are explicitly checking quoting and un-quoting
• Convert january_2018 to the "tidy" formatting returned by csb_get_data(), update unit tests and examples accordingly

Documentation:

• Add index.Rmd for website landing page with less detail (no example - see areal for differences)
• Add quick example to README.Rmd
• Add hex to package
• Clean-up vignette (ensure changes @chris-prener has made are reflected)
• Add new functions (csb_load_variables() and csb_last_update()) to vignette
• Spell check all documentation files - devtools::spell_check()

Release steps:

• Run package through devtools::release_checks()
• Run package through Winbuilder
• Update NEWS.md
• Release what we've got as v0.1.0

Final steps:

• Create branch for CRAN release
• Create can comments document
• Update version number in DESCRIPTION
• Update install sections on README.Rmd, index.Rmd, and vignettes/stlcsb.Rmd
• Rebuild documentation and site
• Final R CMD check
• submit to CRAN!

The .github/ directory is incomplete and needs to have the remainder of the GitHub community files added to it once the cran-release branch is merged into the master.

Tasks:

1. Set-up CI build on GitHub actions
2. Address build errors
3. Add pkgdown GitHub action for site build
4. README.md and repo housekeeping (remove old CI files, update badges)
5. Ensure code coverage is working correctly

Still need to figure out where in the package to store .Rdata files that have definitions for categories.

Currently there is one large .Rdata file with all of the categories, I think that is the most appropriate way to store the data. The Categorize code reflects my working directory, but not a directory that will work for the package.

We're going to remove this category from the export in the near future. They're not technically CSB tickets. Facilities Maintenance issues made it into the auto-update by mistake.