Search for available outsider modules

Source: R/search.R

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

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

Arguments

service

Code-sharing service, e.g. GitHub

Value

Character vector

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".

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
if (FALSE) {
  (available_modules <- module_search())
}

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

#> # A tibble: 0 x 0
repo <- 'dombennett/om..hello.world'
(module_details(repo = repo))

#> # A tibble: 1 x 7
#>   repo    program  details   versions updated_at          watchers_count url    
#>   <chr>   <chr>    <chr>     <chr>    <dttm>                       <int> <chr>  
#> 1 domben… hello w… Template… latest   2019-08-19 09:30:00              0 https:…