Thanks to visit codestin.com
Credit goes to github.com

Skip to content

todo list for version 1.0.0 #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
29 of 46 tasks
sebkopf opened this issue Jun 7, 2023 · 4 comments
Open
29 of 46 tasks

todo list for version 1.0.0 #2

sebkopf opened this issue Jun 7, 2023 · 4 comments
Milestone

Comments

@sebkopf
Copy link
Contributor

sebkopf commented Jun 7, 2023

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% codecov
  • make sure RMD check passes for al operating system R-CMD-check
  • 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 Lifecycle: experimental

First release:

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 sebkopf added this to the version 1.0.0 milestone Jun 7, 2023
@sebkopf
Copy link
Contributor Author

sebkopf commented Jun 9, 2023

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

@JmMcFarlin
Copy link
Collaborator

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

@sebkopf
Copy link
Contributor Author

sebkopf commented Jun 12, 2023

features done, working on wrapping up the unit tests next

@sebkopf
Copy link
Contributor Author

sebkopf commented Jul 28, 2023

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 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants