module_details: Look up details on module(s)

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

Look up details on module(s)

Description

Return a tbl_df of information for outsider module(s) for a given code-sharing service. If repo is NULL, will return details on all available modules.

Usage

module_details(repo = NULL, service = c("github", "bitbucket", "gitlab"))

Arguments

repo	Vector of one or more outsider module repositories, default NULL.
service	Code-sharing service, e.g. GitHub

Details

Module details in tibble format include: repository name (user/repo), last time repo was updated, number of watchers (or stars in the case of GitLab), url to web presence, names of tagged versions.

Value

tbl_df

See Also

Other public: is_module_installed(), module_functions(), module_help(), module_import(), module_installed(), module_install(), module_search(), 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))

AntonelliLab/outsider documentation built on June 17, 2022, 3:27 p.m.