Skip to contents

Augment package configuration metadata

Source: R/pal.gen.R
augment_pkg_config.Rd

Augments a package's configuration metadata (<pkg>::pkg_config) with the columns r_opts and env_var holding the respective R option and environment variable names.

Usage

augment_pkg_config(pkg = utils::packageName(env = parent.frame()))

Arguments

pkg

Package name. A character scalar. Defaults to the name of the calling package.

Value

A tibble with at minimum the columns key, default_value, r_opt and env_var.

See also

Other package configuration functions: has_pkg_config_val(), pkg_config_val(), pkg_config_val_default(), print_pkg_config()

Examples

try(
  pal::augment_pkg_config(pkg = "pkgpurl")
)
#> # A tibble: 3 × 7
#>   key                  default_value default_value_dynamic require description                                                                     r_opt env_var
#>   <chr>                <list>        <chr>                 <lgl>   <chr>                                                                           <chr> <chr>  
#> 1 add_copyright_notice <lgl [1]>     NA                    TRUE    Whether or not to add a **copyright notice** at the beginning of the generated… pkgp… R_PKGP…
#> 2 add_license_notice   <lgl [1]>     NA                    TRUE    Whether or not to add a **license notice** at the beginning of the generated `… pkgp… R_PKGP…
#> 3 gen_pkgdown_ref      <lgl [1]>     NA                    TRUE    Whether or not to overwrite [pkgdown](https://pkgdown.r-lib.org/)'s [reference… pkgp… R_PKGP…