DataPackageR_options: Options consulted by DataPackageR
In DataPackageR: Construct Reproducible Analytic Data Sets as R Packages
DataPackageR_options R Documentation
Options consulted by DataPackageR
Description
User-configurable options consulted by DataPackageR, which
provide a mechanism for setting default behaviors for various functions.
If the built-in defaults don't suit you, set one or more of these options.
Typically, this is done in the .Rprofile startup file, which you can open
for editing with usethis::edit_r_profile() - this will set the specified
options for all future R sessions. The following setting is recommended to
not be prompted upon each package build for a NEWS update:
options(DataPackageR_interact = FALSE)
Options for the DataPackageR package
- DataPackageR_interact: Upon package load, this defaults to the value of
interactive(), unless the option has been previously set (e.g., in
.Rprofile). TRUE prompts user interactively for a NEWS update on
package_build(). See the example above and the
rOpenSci blog
post for more details on how to set this to FALSE, which will never prompt
user for a NEWS update. FALSE is also the setting used for DataPackageR
internal package tests.
- DataPackageR_verbose: Default upon package load is TRUE. FALSE suppresses
all console output and is currently only used for automated
unit tests of the DataPackageR package.
- DataPackageR_packagebuilding: Default upon package load is FALSE. This
option is used internally for package operations and changing it is not
recommended.
DataPackageR documentation built on Sept. 18, 2024, 1:07 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| DataPackageR_options | R Documentation |
Options consulted by DataPackageR
Description
User-configurable options consulted by DataPackageR, which provide a mechanism for setting default behaviors for various functions.
If the built-in defaults don't suit you, set one or more of these options.
Typically, this is done in the .Rprofile startup file, which you can open
for editing with usethis::edit_r_profile() - this will set the specified
options for all future R sessions. The following setting is recommended to
not be prompted upon each package build for a NEWS update:
options(DataPackageR_interact = FALSE)
Options for the DataPackageR package
- DataPackageR_interact: Upon package load, this defaults to the value of
interactive(), unless the option has been previously set (e.g., in
.Rprofile). TRUE prompts user interactively for a NEWS update on
package_build(). See the example above and the
rOpenSci blog
post for more details on how to set this to FALSE, which will never prompt
user for a NEWS update. FALSE is also the setting used for DataPackageR
internal package tests.
- DataPackageR_verbose: Default upon package load is TRUE. FALSE suppresses
all console output and is currently only used for automated
unit tests of the DataPackageR package.
- DataPackageR_packagebuilding: Default upon package load is FALSE. This
option is used internally for package operations and changing it is not
recommended.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.