todo list for version 1.0.0

[sebkopf]

In this thread add any todo items for getting version 1.0.0 ready to submit to cran

• implement vertically stacked plots
• implement horizontally stacked plots
• address all bugs/features for version 1.0.0 milestone
• write unit tests to increase code coverage to > 80%
• make sure RMD check passes for al operating system
• document all functions thoroughly
• write vignette to demonstrate all functionality (simple and advanced examples) with easily available data (e.g. mtcars), features to document (not an exhaustive list)
  • basic plot stacking in x and y
  • using tidyselect syntax to change x/y axis labels
  • changing colors
  • changing overlap
  • changing axis positioning
  • using the template to add geoms
  • using the template to modify scales
  • using the template to modify themes
  • using the template to add other aesthetics (e.g. linetype)
  • using the template and geom_...(data = ...) to show geoms in different panels
• write vignette(s) to demonstrate functionality with real data (ideally paleo or oceanography data)
• make sure documentation is up to date and properly rendered https://ggstackplot.kopflab.org/
• make sure package metadata is complete (authors, description, etc.)
• update lifecycle to stable

First release:

• usethis::use_cran_comments()
• Update (aspirational) install instructions in README
• Proofread Title: and Description:
• Check that all exported functions have @return and @examples
• Check that Authors@R: includes a copyright holder (role 'cph')
• Check licensing of included files
• Review https://github.com/DavisVaughan/extrachecks

Prepare for release:

• git pull
• Check if any deprecation processes should be advanced, as described in Gradual deprecation
• urlchecker::url_check()
• devtools::check(remote = TRUE, manual = TRUE)
• devtools::check_win_devel()
• rhub::check_for_cran()
• git push
• Draft blog post

Submit to CRAN:

• usethis::use_version('major')
• devtools::submit_cran()
• Approve email

Wait for CRAN...

• Accepted 🎉
• git push
• usethis::use_github_release()
• usethis::use_dev_version()
• usethis::use_news_md()
• git push
• Tweet / advertize

[sebkopf]

i'm working on the address all bugs/features part

[JmMcFarlin]

I'm working on a vignette w/ some published paleoclimate data

[sebkopf]

features done, working on wrapping up the unit tests next

[sebkopf]

thanks for all the work on documenting features and adding real data example @tacaro (and catching two more important bugs :) - now we just need a few more examples (@JmMcFarlin / @rabergj ?) :) and we're ready for CRAN 🚀