Skip to contents

Package configuration data

Source: R/funky.gen.R
config.Rd

Retrieves a package's funky configuration data (<pkg>:::funky_config).

Usage

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

Arguments

pkg

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

Value

A tibble with the columns key, default_value, default_value_dynamic, require, and description.

See also

Other package configuration data functions: augment_config(), print_config(), ptype_config

Examples

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