Skip to contents

Removes package(s) from a SsimLibrary.

Usage

removePackage(ssimLibrary, packages)

# S4 method for class 'character'
removePackage(ssimLibrary, packages)

# S4 method for class 'SsimLibrary'
removePackage(ssimLibrary, packages)

Arguments

ssimLibrary

SsimLibrary object

packages

character string or vector of package name(s)

Value

This function invisibly returns TRUE upon success (i.e.successful removal of the package) or FALSE upon failure.

See also

Examples

# \donttest{
# Install "stsim" and "stsimecodep" SyncroSim packages
installPackage("stsim")
#> Package <stsim v4.0.1> 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")
#> Package <stsim v4.0.1> added
addPackage(myLibrary, packages = "stsimecodep")
#> Package <stsimecodep v4.0.0> added
packages(myLibrary)
#>          name
#> 1        core
#> 2       stsim
#> 3 stsimecodep
#>                                                                         description
#> 1                                                            SyncroSim Core Package
#> 2                                  The ST-Sim state-and-transition simulation model
#> 3 Calculates TNC's unified ecological departure from reference conditions in ST-Sim
#>   version schema
#> 1   3.0.9      3
#> 2   4.0.1      4
#> 3   4.0.0      4
#>                                                                                   status
#> 1                                                                                     OK
#> 2                                                                                     OK
#> 3 Info - The 'stsimecodep' Package was built for version '4.0.0' of the 'stsim' Package.

# 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
# }