ready4 submodule class for package metadata required for initial package set-up step.
Source:R/C3_ready4fun_metadata_a.R
ready4fun_metadata_a.Rd
Create a new valid instance of the ready4 submodule class for package metadata required for initial package set-up step.
Usage
ready4fun_metadata_a(x = make_pt_ready4fun_metadata_a())
make_pt_ready4fun_metadata_a(
pkg_desc_ls = ready4fun_description(),
copyright_holders_chr = character(0),
gh_repo_1L_chr = character(0),
add_gh_site_1L_lgl = logical(0),
addl_badges_ls = list(),
badges_lup = ready4fun_badges(),
check_type_1L_chr = character(0),
delete_r_dir_cnts_1L_lgl = logical(0),
dev_pkg_nm_1L_chr = character(0),
lifecycle_stage_1L_chr = character(0),
incr_ver_1L_lgl = logical(0),
on_cran_1L_lgl = logical(0),
path_to_pkg_logo_1L_chr = character(0),
path_to_pkg_rt_1L_chr = character(0)
)
is_ready4fun_metadata_a(x)
Arguments
- x
An object of any type
- pkg_desc_ls
Package description (a list), Default: ready4fun_description()
- copyright_holders_chr
Copyright holders (a character vector), Default: character(0)
- gh_repo_1L_chr
Github repository (a character vector of length one), Default: character(0)
- add_gh_site_1L_lgl
Add github site (a logical vector of length one), Default: logical(0)
- addl_badges_ls
Additional badges (a list), Default: list()
- badges_lup
Badges (a lookup table), Default: ready4fun_badges()
- check_type_1L_chr
Check type (a character vector of length one), Default: character(0)
- delete_r_dir_cnts_1L_lgl
Delete r directory contents (a logical vector of length one), Default: logical(0)
- dev_pkg_nm_1L_chr
Development package name (a character vector of length one), Default: character(0)
- lifecycle_stage_1L_chr
Lifecycle stage (a character vector of length one), Default: character(0)
- incr_ver_1L_lgl
Increment version (a logical vector of length one), Default: logical(0)
- on_cran_1L_lgl
On cran (a logical vector of length one), Default: logical(0)
- path_to_pkg_logo_1L_chr
Path to package logo (a character vector of length one), Default: character(0)
- path_to_pkg_rt_1L_chr
Path to package root (a character vector of length one), Default: character(0)
Value
A validated instance of the ready4 submodule class for package metadata required for initial package set-up step.
A prototype for ready4 submodule class for package metadata required for initial package set-up step.
A logical value, TRUE if a valid instance of the ready4 submodule class for package metadata required for initial package set-up step.