Title: Check if the Title of a Package is Available, Appropriate and Interesting
Version: 1.1.0
Description: Check if a given package name is available to use. It checks the name's validity. Checks if it is used on 'GitHub', 'CRAN' and 'Bioconductor'. Checks for unintended meanings by querying 'Wiktionary' and Wikipedia.
Depends: R (≥ 3.3.0)
License: MIT + file LICENSE
Encoding: UTF-8
RoxygenNote: 7.2.0.9000
Imports: cli, clisymbols, crayon, tidytext, desc, glue, jsonlite, memoise, SnowballC, stringdist, tibble, yesno
Suggests: usethis, BiocManager, testthat, covr
URL: https://github.com/r-lib/available
BugReports: https://github.com/r-lib/available/issues
NeedsCompilation: no
Packaged: 2022-07-10 18:40:17 UTC; gaborcsardi
Author: Carl Ganz [aut], Gábor Csárdi [aut, cre], Jim Hester [aut], Molly Lewis [aut], Rachael Tatman [aut]
Maintainer: Gábor Csárdi <csardi.gabor@gmail.com>
Repository: CRAN
Date/Publication: 2022-07-10 19:00:02 UTC

See if a name is available

Description

Searches performed

Usage

available(name, browse = getOption("available.browse", TRUE), ...)

Arguments

name

Name of package to search

browse

Whether browser should be opened for all web links, default = TRUE. Default can be changed by setting available.browse in .Rprofile. See Startup for more details.

...

Additional arguments passed to utils::available.packages().

Examples

## Not run: 
# Check if the available package is available
available("available")

# You can disable opening of browser windows with browse = FALSE
available("survival", browse = FALSE)

# Or by setting a global option
options(available.browse = FALSE)
available("survival")

# Test if a name is available in a non-default CRAN repository by setting
# the `repos` argument
available_on_cran("semaforos")

available_on_cran("semaforos", repos = "https://bisaloo.r-universe.dev")

## End(Not run)

See if a name is available on CRAN

Description

See if a name is available on CRAN

Usage

available_on_bioc(name, repos = NULL, ...)

available_on_cran(name, repos = default_cran_repos, ...)

Arguments

name

Name of package to search

repos

character vector, the base URL(s) of the repositories to use.

...

Additional arguments passed to utils::available.packages().

Examples

available_on_cran("semaforos")

# Test if this name is available in a non-default CRAN repository
## Not run: 
available_on_cran("semaforos", repos = "https://bisaloo.r-universe.dev")

## End(Not run)

See if a name is available on github

Description

See if a name is available on github

Usage

available_on_github(name)

Arguments

name

Name of package to search

function to add common, informative suffixes

Description

Search a title for common terms (plot, vis..., viz..., markdown) and apply appropriate affixes to a given word as applicable.

Usage

common_suffixes(title, name)

Arguments

title

the package title or description

name

the single word that will be appended to

Value

a single word with affix, if applicable

Check a new package name and possibly create it

Description

Check a new package name and possibly create it

Usage

create(name, ...)

Arguments

name

Name of package to search

...

Additional arguments passed to usethis::create_package().

Function that finds and returns the first acronym (all caps) in a text string

Description

Function that finds and returns the first acronym (all caps) in a text string

Usage

find_acronym(title)

Arguments

title

package title or description

Value

a single acronym, if present

Check for bad words in name

Description

Check for bad words in name

Usage

get_bad_words(name)

Arguments

name

Name of package to search

See Also

See https://github.com/web-mech/badwords

Get sentiment of name

Description

Get sentiment of name

Usage

get_sentiment(name)

Arguments

name

Name of package to search

Open wikipedia page and abbreviations.com page

Description

Open wikipedia page and abbreviations.com page

Usage

get_wikipedia(name)

get_wiktionary(name)

Arguments

name

Name of package to search

Spelling transformations

Description

This function takes in a single word and applies spelling transformations to make it more "r-like" and easier to Google

Usage

make_spelling_rlike(word)

Arguments

word

a single word to make more rlike

Value

a single word with a spelling transformation

Suggest package name

Description

Suggests a package name based on the package title or description.

Usage

namr(title, acronym = FALSE, verb = FALSE, ...)

Arguments

title

the package title or description

acronym

whether to include an acronym (if there is one) in the title

verb

whether to prioritize using a verb in the package title

Value

a single word to use as a package title

Pick word from title

Description

picks a single (hopefully informative) word from the provided title or package description

Usage

pick_word_from_title(title, verb = FALSE)

Arguments

title

text string to pick word from. Package title or description.

verb

whether you would like to prioritize returning a verb

Value

a single word from the title

Find five closest package names in terms of string distance

Description

Find five closest package names in terms of string distance

Usage

pkg_name_dist(name, pkgs)

Arguments

name

name of package

pkgs

packages to compare with

Suggest a package name based on a development package title or description

Description

If the package you are using already has a title, simply pass the path to the package root in path. Otherwise use title to specify a potential title.

Usage

suggest(path = ".", field = c("Title", "Description"), text = NULL)

Arguments

path

Path to a existing package to extract the title from.

field

one of "Title" or "Description"

text

text string to search.

Examples

## Not run: 
# Default will use the title from the current path.
suggest()

# Can also suggest based on the description
suggest(field = "Description")

## End(Not run)

# Or by explicitly using the text argument
suggest(text =
  "A Package for Displaying Visual Scenes as They May Appear to an Animal with Lower Acuity")

Is a package name valid

Description

Is a package name valid

Usage

valid_package_name(name)

Arguments

name

Name of package to search