Skip to contents

Add SyncroSim package(s)

Source: R/addPackage.R
addPackage.Rd

Adds package(s) to a SsimLibrary.

Usage

addPackage(ssimLibrary, packages, versions = NULL, forceUpdate = FALSE)

# S4 method for class 'character'
addPackage(ssimLibrary, packages, versions = NULL, forceUpdate = FALSE)

# S4 method for class 'SsimLibrary'
addPackage(ssimLibrary, packages, versions = NULL, forceUpdate = FALSE)

Arguments

ssimLibrary

SsimLibrary object

packages

character string or vector of package name(s)

versions

character string or vector of package version(s). If NULL then uses the latest installed version of the package

forceUpdate

logical. If FALSE (default) user will be prompted to approve any required updates. If TRUE, required updates will be applied silently.

Value

Invisibly returns TRUE upon success (i.e.successful addition of the package) or FALSE upon failure.

See also

packages

Examples

# \donttest{
# Install "stsim" and "stsimecodep" SyncroSim packages
installPackage(packages = c("stsim", "stsim"),
               versions = c("4.0.0", "4.0.1"))
#> Package <stsim v4.0.0> installed
installPackage("stsimecodep")
#> [1] "Package stsimecodep v4.0.0 is already installed."

# Specify file path and name of new SsimLibrary
myLibraryName <- file.path(tempdir(), "testlib")

# Set up a SyncroSim Session, SsimLibrary, and Project
mySession <- session()
myLibrary <- ssimLibrary(name = myLibraryName, session = mySession)

# Add package
addPackage(myLibrary, packages = "stsim", versions = "4.0.1")
#> [1] "Package stsim v4.0.1 is not among the available packages."
addPackage(myLibrary, packages = "stsimecodep")
#> Package <stsimecodep v4.0.0> added
packages(myLibrary)
#>          name
#> 1        core
#> 2 stsimecodep
#>                                                                         description
#> 1                                                            SyncroSim Core Package
#> 2 Calculates TNC's unified ecological departure from reference conditions in ST-Sim
#>   version schema status
#> 1   3.0.9      3     OK
#> 2   4.0.0      4     OK

# Change package version
addPackage(myLibrary, packages = "stsim", versions = "4.0.0")
#> Package <stsim v4.0.0> added
addPackage(myLibrary, packages = "stsim", versions = "4.0.1")
#> [1] "Package stsim v4.0.1 is not among the available packages."

# Remove package
removePackage(myLibrary, packages = c("stsim", "stsimecodep"))
#> Package <stsim> removed
#> Package <stsimecodep> removed
packages(myLibrary)
#>   name            description version schema status
#> 1 core SyncroSim Core Package   3.0.9      3     OK
# }