Release bakepipe 0.2.0

[vangberg]

First release:

• Update installation in README.md
• usethis::use_news_md()
• 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
• usethis::use_github_links()
• urlchecker::url_check()
• devtools::check(remote = TRUE, manual = TRUE)
• devtools::check_win_devel()
• git push
• Draft blog post

Submit to CRAN:

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

Wait for CRAN...

• Accepted 🎉
• Finish & publish blog post
• Add link to blog post in pkgdown news menu
• usethis::use_github_release()
• usethis::use_dev_version(push = TRUE)
• usethis::use_news_md()
• Share on social media

[vangberg]

Reply from CRAN:

You have examples for unexported functions. Please either omit these
examples or export these functions.

-> Examples for unexported function
find_descendants() in:
find_descendants.Rd
graph() in:
find_descendants.Rd
graph.Rd
topological_sort.Rd
parse() in:
find_descendants.Rd
graph.Rd
parse.Rd
topological_sort.Rd
read_state() in:
graph.Rd
root() in:
root.Rd
scripts() in:
scripts.Rd
topological_sort() in:
topological_sort.Rd

\dontrun{} should only be used if the example really cannot be executed
(e.g. because of missing additional software, missing API keys, ...) by
the user. That's why wrapping examples in \dontrun{} adds the comment
("# Not run:") as a warning for the user. Does not seem necessary.
Please replace \dontrun with \donttest.

Please unwrap the examples if they are executable in < 5 sec, or replace
dontrun{} with \donttest{}.

Please add small files needed for the examples or vignette in the
inst/extdata subfolder of your package and use system.file() to get the
correct package path.

For more details:
https://contributor.r-project.org/cran-cookbook/general_issues.html#structuring-of-examples

You write information messages to the console that cannot be easily
suppressed.
It is more R like to generate objects that can be used to extract the
information a user is interested in, and then print() that object.
Instead of cat() rather use message()/warning() or if(verbose)cat(..)
(or maybe stop()) if you really have to write text to the console.
(except for print, summary, interactive functions) -> R/clean.R;
R/run.R; R/status.R
For more details:
https://contributor.r-project.org/cran-cookbook/code_issues.html#using-printcat

Please ensure that your functions do not write by default or in your
examples/vignettes/tests in the user's home filespace (including the
package directory and getwd()). This is not allowed by CRAN policies.
Please omit any default path in writing functions. In your
examples/vignettes/tests you can write to tempdir().
For more details:
https://contributor.r-project.org/cran-cookbook/code_issues.html#writing-files-and-directories-to-the-home-filespace

Please fix and resubmit.

[vangberg]

Prepare for resubmission to CRAN:

• Remove examples for unexported functions
• Unwrap examples (don't use \dontrun or donttest)
• Create minimal example project in inst/extdata for use with @example code
• Update examples to use sample proejct in inst/extdata
• Add verbose = TRUE to run, clean, status
• Use tempdir in all tests and all examples

[vangberg]

Reply from CRAN:

we still see:
Examples in comments in:
external_in.Rd
file_in.Rd
file_out.Rd
Please uncomment these examples and wrap them in \donttest{}.
For more details:
https://contributor.r-project.org/cran-cookbook/general_issues.html#structuring-of-examples

You write information messages to the console that cannot be easily
suppressed.
It is more R like to generate objects that can be used to extract the
information a user is interested in, and then print() that object.
Instead of print()/cat() rather use message()/warning() or
if(verbose)cat(..) (or maybe stop()) if you really have to write text to
the console. (except for print, summary, interactive functions)
-> R/graph.R
For more details:
https://contributor.r-project.org/cran-cookbook/code_issues.html#using-printcat

Please fix and resubmit.