| Title: | Check if the Title of a Package is Available, Appropriate and Interesting |
|---|---|
| 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. |
| Authors: | Carl Ganz [aut], Gábor Csárdi [aut, cre], Jim Hester [aut], Molly Lewis [aut], Rachael Tatman [aut], Posit Software, PBC [cph, fnd] |
| Maintainer: | Gábor Csárdi <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 1.1.0.9000 |
| Built: | 2024-07-02 04:17:33 UTC |
| Source: | https://github.com/r-lib/available |
Searches performed
Valid package name
Already taken on CRAN
Positive or negative sentiment
available(name, browse = getOption("available.browse", TRUE), ...)available(name, browse = getOption("available.browse", TRUE), ...)
name |
Name of package to search |
browse |
Whether browser should be opened for all web links,
default = TRUE. Default can be changed by setting
|
... |
Additional arguments passed to |
## 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)## 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
available_on_bioc(name, repos = NULL, ...) available_on_cran(name, repos = default_cran_repos, ...)available_on_bioc(name, repos = NULL, ...) available_on_cran(name, repos = default_cran_repos, ...)
name |
Name of package to search |
repos |
character vector, the base URL(s) of the repositories to use. |
... |
Additional arguments passed to |
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)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
available_on_github(name)available_on_github(name)
name |
Name of package to search |
Check a new package name and possibly create it
create(name, ...)create(name, ...)
name |
Name of package to search |
... |
Additional arguments passed to |
Check for bad words in name
get_bad_words(name)get_bad_words(name)
name |
Name of package to search |
See https://github.com/web-mech/badwords
Get sentiment of name
get_sentiment(name)get_sentiment(name)
name |
Name of package to search |
Open wikipedia page and abbreviations.com page
get_wikipedia(name) get_wiktionary(name)get_wikipedia(name) get_wiktionary(name)
name |
Name of package to search |
Find five closest package names in terms of string distance
pkg_name_dist(name, pkgs)pkg_name_dist(name, pkgs)
name |
name of package |
pkgs |
packages to compare with |
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.
suggest(path = ".", field = c("Title", "Description"), text = NULL)suggest(path = ".", field = c("Title", "Description"), text = NULL)
path |
Path to a existing package to extract the title from. |
field |
one of "Title" or "Description" |
text |
text string to search. |
## 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" )## 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
valid_package_name(name)valid_package_name(name)
name |
Name of package to search |