module_search: Search for available outsider modules

In outsider: Install and Run Programs, Outside of R, Inside of R

Description

Return a list of available outsider modules. (Not possible for BitBucket.)

Usage

module_search(service = c("github", "gitlab"))

Arguments

service

Code-sharing service, e.g. GitHub

Details

Note: To search GitLab an access token is required. To create one: 1. Visit the personal access tokens section of your GitLab profile https://about.gitlab.com/ 2. Create a new token with api scope 3. Save the generated token to .Renviron (try usethis::edit_r_environ()) with the line "GITLAB_PAT=your access token"

For increased search relaiability, a token can be created for GitHub as well. Visit https://github.com/settings/tokens to create a token and save it to .Renviron as "GITHUB_PAT".

Value

Character vector

See Also

Other public: is_module_installed(), module_details(), module_functions(), module_help(), module_import(), module_installed(), module_install(), module_uninstall()

Examples

library(outsider)
# return table of ALL available modules on GitHub
# NOT RUN - takes too long
## Not run: 
  (available_modules <- module_search())

## End(Not run)

# look-up specific modules
repo <- 'dombennett/om..goodbye.world'
(suppressWarnings(module_details(repo = repo))) # no module exists, expect warning
repo <- 'dombennett/om..hello.world'
(module_details(repo = repo))

outsider documentation built on Dec. 15, 2020, 5:19 p.m.