Skip to contents

Get house style abbreviations

Source: R/fn_get.R
get_abbrs.Rd

An aspect of the ready4 framework is a consistent house style for code. Retrieve details on framework abbreviations with get_abbrs().

Usage

get_abbrs(
  what_1L_chr = character(0),
  type_1L_chr = c("abbreviation", "extension"),
  abbreviations_lup = NULL,
  gh_repo_1L_chr = "ready4-dev/ready4",
  gh_tag_1L_chr = "Documentation_0.0",
  dv_nm_1L_chr = NA_character_,
  dv_ds_metadata_ls = list(list()),
  dv_ds_nm_1L_chr = NA_character_,
  dv_server_1L_chr = NA_character_,
  dv_url_pfx_1L_chr = NA_character_,
  search_descs_1L_lgl = deprecated()
)

Arguments

what_1L_chr

What (a character vector of length one), Default: character(0)

type_1L_chr

Type (a character vector of length one), Default: c("abbreviation", "extension")

abbreviations_lup

Abbreviations (a lookup table), Default: NULL

gh_repo_1L_chr

Github repository (a character vector of length one), Default: 'ready4-dev/ready4'

gh_tag_1L_chr

Github tag (a character vector of length one), Default: 'Documentation_0.0'

dv_nm_1L_chr

Dataverse name (a character vector of length one), Default: 'NA'

dv_ds_metadata_ls

Dataverse dataset metadata (a list), Default: list(list())

dv_ds_nm_1L_chr

Dataverse dataset name (a character vector of length one), Default: 'NA'

dv_server_1L_chr

Dataverse server (a character vector of length one), Default: 'NA'

dv_url_pfx_1L_chr

Dataverse url prefix (a character vector of length one), Default: 'NA'

search_descs_1L_lgl

Search descriptions (a logical vector of length one), Default: deprecated()

Value

Abbreviations (a lookup table)

Examples

library(ready4)
# Get current table of abbreviations
abbreviations_lup <- get_abbrs(gh_repo_1L_chr = "ready4-dev/ready4")
abbreviations_lup %>% head()
#> # A tibble: 6 × 3
#>   short_name_chr long_name_chr                           plural_lgl
#>   <chr>          <chr>                                   <lgl>     
#> 1 ...            additional arguments                    NA        
#> 2 1L             length one                              FALSE     
#> 3 1L_chr         character vector of length one          FALSE     
#> 4 1L_chr_ls      list of character vectors of length one FALSE     
#> 5 1L_dbl         double vector of length one             FALSE     
#> 6 1L_dbl_ls      list of double vectors of length one    FALSE     
# Find abbreviations for a word
get_abbrs("template", abbreviations_lup = abbreviations_lup)
#> # A tibble: 2 × 3
#>   short_name_chr long_name_chr plural_lgl
#>   <chr>          <chr>         <lgl>     
#> 1 tmpl           template      FALSE     
#> 2 tmpls          templates     TRUE      
# Find possible whole word meanings associated with an abbreviation
get_abbrs("org", type_1L_chr = "extension", abbreviations_lup = abbreviations_lup)
#> # A tibble: 2 × 3
#>   short_name_chr long_name_chr plural_lgl
#>   <chr>          <chr>         <lgl>     
#> 1 org            organisation  FALSE     
#> 2 orgs           organisations TRUE