pkg_name_check: Check if an R package name is available

In r-lib/pak: Another Approach to Package Installation

Check if an R package name is available

Description

Additionally, look up the candidate name in a number of dictionaries, to make sure that it does not have a negative meaning.

Usage

pkg_name_check(name, dictionaries = NULL)

Arguments

name	Package name candidate.
dictionaries	Character vector, the dictionaries to query. Available dictionaries: * wikipedia * wiktionary, * sentiment (https://github.com/fnielsen/afinn), * urban (Urban Dictionary). If NULL (by default), the Urban Dictionary is omitted, as it is often offensive.

Details

Valid package name check

Check the validity of name as a package name. See 'Writing R Extensions' for the allowed package names. Also checked against a list of names that are known to cause problems.

CRAN checks

Check name against the names of all past and current packages on CRAN, including base and recommended packages.

Bioconductor checks

Check name against all past and current Bioconductor packages.

Profanity check

Check name with https://www.purgomalum.com/service/containsprofanity to make sure it is not a profanity.

Dictionaries

See the dictionaries argument.

Value

pkg_name_check object with a custom print method.

Examples

pkg_name_check("sicily")

#> ╔══════════════════════════════════════════════════════════════════════╗
#> ║                            –*– sicily –*–                            ║
#> ╚══════════════════════════════════════════════════════════════════════╝
#> ┌──────────────────────────────────────────────────────────────────────┐
#> │ ✔  valid name          ✔  CRAN               ✔  Bioconductor         │
#> │ ✔  not a profanity                                                   │
#> └──────────────────────────────────────────────────────────────────────┘
#> ┌ Wikipedia ───────────────────────────────────────────────────────────┐
#> │ Sicily Sicily (Italian: Sicilia [siˈtʃiːlja], Sicilian               │
#> │ pronunciation: [sɪˈʃiːlja]) is the largest island in the             │
#> │ Mediterranean Sea and one of the 20 regions of Italy. The Strait of  │
#> │ Messina divides it from the region of Calabria in Southern Italy.    │
#> │ It is one of the five Italian autonomous regions and is officially   │
#> │ referred to as Regione Siciliana. The region has 5 million           │
#> │ …                                                                    │
#> └──────────────────────────────── https://en.wikipedia.org/wiki/Sicily ┘
#> ┌ Wiktionary ──────────────────────────────────────────────────────────┐
#> │ sicily No English definition found                                   │
#> └────────────────────────────────────────────────────────────────────  ┘
#> ┌──────────────────────────────────────────────────────────────────────┐
#> │ Sentiment: 😐 (0)                                                    │ 
#> └──────────────────────────────────────────────────────────────────────┘

r-lib/pak documentation built on April 10, 2024, 8:23 p.m.