dsadmin.install_package: Install a DataSHIELD package

View source: R/datashield.admin.R

dsadmin.install_packageR Documentation

Install a DataSHIELD package

Description

Install a package from DataSHIELD public package repository or (if Git reference and GitHub username is provided) from DataSHIELD source repository on GitHub.

Usage

dsadmin.install_package(
  opal,
  pkg,
  githubusername = NULL,
  ref = NULL,
  profile = NULL
)

Arguments

opal

Opal object or list of opal objects.

pkg

Package name.

githubusername

GitHub username of git repository. If NULL (default), try to install from DataSHIELD package repository.

ref

Desired git reference (could be a commit, tag, or branch name). If NULL (default), try to install from DataSHIELD package repository.

profile

The DataSHIELD profile name to which operation applies. See also dsadmin.profiles.

Value

TRUE if installed

See Also

Other DataSHIELD functions: dsadmin.get_methods(), dsadmin.get_method(), dsadmin.get_options(), dsadmin.install_github_package(), dsadmin.install_local_package(), dsadmin.installed_package(), dsadmin.package_descriptions(), dsadmin.package_description(), dsadmin.publish_package(), dsadmin.remove_package(), dsadmin.rm_methods(), dsadmin.rm_method(), dsadmin.rm_options(), dsadmin.rm_option(), dsadmin.rm_package_methods(), dsadmin.set_method(), dsadmin.set_option(), dsadmin.set_package_methods(), dsadmin.unpublish_package()

Examples

## Not run: 
o <- opal.login('administrator','password', url='https://opal-demo.obiba.org')
dsadmin.install_package(o, 'dsBase')
opal.logout(o)

## End(Not run)

opalr documentation built on Oct. 6, 2023, 5:08 p.m.