Skip to content

cran-comments.md

Latest commit

 

History

History
105 lines (72 loc) · 3.71 KB

cran-comments.md

File metadata and controls

105 lines (72 loc) · 3.71 KB
Raw

R CMD check results

0 errors | 0 warnings | 0 notes

Reviewer comments

This is a resubmission. Version 0.1.12.

Changes since last submission (0.1.11)

NEW FEATURES

  • Added open_cffinit() — opens the CFF initializer in a browser to generate CITATION.cff files.

MINOR IMPROVEMENTS

  • Removed redundant dependency standalone-purrr in standalone-args_to_func.R.
  • Beautified the changelog format in standalone files created by add_changelog_in_standalone().
  • Added community files (CONTRIBUTING.md, SUPPORT.md, issue template).
  • Added informative message when opening CFF initializer.

DOCUMENTATION

  • Fixed an error in examples of filter_args_for_func() in standalone-args_to_func.R.

Test results

All 1182 tests pass with 0 failures (devtools::test()).

Previous responses (for historical reference)

R CMD check results (v0.1.11)

Writing to home filespace

All functions that previously defaulted to path = "." now use path = NULL as the default parameter. The following functions were updated:

  • use_zzz()
  • add_global_rbuildignore()
  • news_md_check(), news_md_show(), news_md_add_entry()
  • use_hexsticker(), use_workflow_version_update()
  • use_vendor(), use_multilanguage_readme()
  • package_lost_glue_brace(), package_print_and_cat()
  • package_func_call_explicit(), package_func_arg_explicit()
  • Internal helpers: vendor_declare_source_license(), vendor_create_r_file(), vendor_update_desc(), get_package_name()

All examples and tests write to tempdir() or tempfile() only, and all temporary files are properly cleaned up (using withr::local_tempdir(), withr::local_tempfile(), or on.exit(unlink(...))).

R CMD check results (v0.1.7 — initial submission)

1. Description and Title

The Description no longer starts with wording similar to the Title. The single quotes around 'R' in the Title have been removed to be consistent with the Description text, which uses R without quotes.

2. Missing \value tags in .Rd files

Added @return roxygen documentation for is_dev_context(), imported_functions(), and current_packages() in R/vendor-pedant.R. man/current_packages.Rd now includes a \value section describing the return value of each exported function.

3. \dontrun{} replaced with \donttest{}

Replaced \dontrun{} with \donttest{} in all examples except for three functions that genuinely require external software or API keys:

  • browse_standalone() — requires GitHub API authentication
  • inquire_standalone() — queries the GitHub API
  • air_format() — requires the external air binary
  • news_md_check(), news_md_add_entry(), news_md_show(), check_pkgdown_reference, use_workflow_version_update(), use_zzz() - requires R package usethis

4. cat() replaced with message()

In R/14_detect_lost_glue_brace.R, the cat() call (and the adjacent cli::cli_text("")) has been replaced with message(), which is the recommended approach for informational messages that can be suppressed.

5. Writing to home filespace / getwd()

All functions that previously used getwd() (or the internal get_wd() helper) as a default path fallback now use path = "." as the default parameter value. Specifically:

  • news_md_add_entry(), news_md_check(), news_md_show(): changed path = NULL + getwd() fallback → path = "."
  • use_workflow_version_update(), use_hexsticker(): changed path = NULL + getwd() fallback → path = "."
  • create_standalone(): changed path = NULL + get_wd() fallback → path = "."
  • Internal get_wd() function: fallback changed from getwd() to "."

In examples and vignettes, tempdir() is used where file writing is needed.