Create a package example producing notes and errors

Create a package example producing notes and errors

create_example_pkg(
  path = tempfile(pattern = "pkg-"),
  with_functions = TRUE,
  with_extra_notes = FALSE
)

Arguments

path

Path where to store the example package

with_functions

Logical. Whether there will be functions or not (with notes)

with_extra_notes

Logical. Whether there are extra notes or not

Value

Path where the example package is stored.

Examples

create_example_pkg()
#> ✔ Creating '/tmp/RtmpFU8HyQ/pkg-18996b536aee/checkpackage/'
#> ✔ Setting active project to '/tmp/RtmpFU8HyQ/pkg-18996b536aee/checkpackage'
#> ✔ Creating 'R/'
#> ✔ Writing 'DESCRIPTION'
#> Package: checkpackage
#> Title: What the Package Does (One Line, Title Case)
#> Version: 0.0.0.9000
#> Authors@R (parsed):
#>     * First Last <first.last@example.com> [aut, cre] (YOUR-ORCID-ID)
#> Description: What the package does (one paragraph).
#> License: `use_mit_license()`, `use_gpl3_license()` or friends to
#>     pick a license
#> Encoding: UTF-8
#> Roxygen: list(markdown = TRUE)
#> RoxygenNote: 7.3.0
#> ✔ Writing 'NAMESPACE'
#> ✔ Setting active project to '<no active project>'
#> Saving attachment parameters to yaml config file
#> Updating checkpackage documentation
#> Writing NAMESPACE
#> ℹ Loading checkpackage
#> ✖ function.R:4: @return requires a value.
#> Writing NAMESPACE
#> Writing my_long_fun_name_for_multiple_lines_globals.Rd
#> Writing my_plot.Rd
#> Writing my_not_exported_doc.Rd
#> ℹ Loading checkpackage
#> [+] 1 package(s) added: dplyr.
#> [1] "/tmp/RtmpFU8HyQ/pkg-18996b536aee/checkpackage"