Retrieves the packages installed or available in the current session if
called on a Session object, or the packages added to a
SyncroSim Library if called on a SsimLibrary object.
Usage
packages(ssimObject = NULL, installed = TRUE)
# S4 method for class 'character'
packages(ssimObject = NULL, installed = TRUE)
# S4 method for class 'missingOrNULL'
packages(ssimObject = NULL, installed = TRUE)
# S4 method for class 'Session'
packages(ssimObject = NULL, installed = TRUE)
# S4 method for class 'SsimLibrary'
packages(ssimObject)Arguments
- ssimObject
SessionorSsimLibraryobject. IfNULL(default),session()will be used- installed
logical or character.
TRUE(default) to list installed packages orFALSEto list available packages on the server
Examples
# \donttest{
# Set the file path and name of the new SsimLibrary
myLibraryName <- file.path(tempdir(),"testlib")
# Set the SyncroSim Session and SsimLibrary
mySession <- session()
myLibrary <- ssimLibrary(name = myLibraryName, session = mySession)
#> Warning: The following package associated with this library is not properly installed: stsim v4.3.5
#> Use installPackage(packages = 'stsim', versions = '4.3.5') to install.
# List all installed packages
packages(mySession)
#> name version
#> 1 burnP3Plus 2.1.1
#> 2 burnP3PlusCell2Fire 2.0.2
#> 3 stsim 4.3.5
#> 4 wisdm 2.1.11
#> 5 wisdm 2.1.12
#> description
#> 1 Burn probability modeling
#> 2 Cell2Fire fire growth model for BurnP3+
#> 3 The ST-Sim state-and-transition simulation model
#> 4 Workbench for Integrated Species Distribution Modeling
#> 5 Workbench for Integrated Species Distribution Modeling
#> location
#> 1 C:\\Users\\birch\\AppData\\Local\\SyncroSim\\Packages\\burnP3Plus\\2.1.1
#> 2 C:\\Users\\birch\\AppData\\Local\\SyncroSim\\Packages\\burnP3PlusCell2Fire\\2.0.2
#> 3 C:\\Users\\birch\\AppData\\Local\\SyncroSim\\Packages\\stsim\\4.3.5
#> 4 C:\\Users\\birch\\AppData\\Local\\SyncroSim\\Packages\\wisdm\\2.1.11
#> 5 C:\\gitprojects\\wisdm\\src
#> status
#> 1 OK
#> 2 OK
#> 3 OK
#> 4 OK
#> 5 OK
# List all available packages on the server (including currently installed)
packages(installed = FALSE)
#> name version
#> 1 burnP3Plus 2.0.0
#> 2 burnP3Plus 2.1.0
#> 3 burnP3Plus 2.1.1
#> 4 burnP3PlusCell2Fire 2.0.0
#> 5 burnP3PlusCell2Fire 2.0.2
#> 6 burnP3PlusFireSTARR 1.0.3
#> 7 burnP3PlusFireSTARR 1.0.4
#> 8 burnP3PlusFireSTARR 1.0.6
#> 9 burnP3PlusPrometheus 2.0.0
#> 10 burnP3PlusPrometheus 2.0.1
#> 11 demosales 2.0.0
#> 12 dgsim 3.0.0
#> 13 ecoClassify 1.0.2
#> 14 helloworld 2.0.0
#> 15 helloworld 2.0.1
#> 16 helloworldPipeline 2.0.0
#> 17 helloworldSpatial 2.0.0
#> 18 helloworldTime 2.0.0
#> 19 helloworldTimePy 2.0.0
#> 20 helloworldUncertainty 2.0.1
#> 21 omniscape 2.1.1
#> 22 omniscapeImpact 2.0.0
#> 23 prioritizr 2.2.1
#> 24 stsim 4.0.1
#> 25 stsim 4.3.5
#> 26 stsim 4.3.6
#> 27 stsimecodep 4.0.0
#> 28 wisdm 2.1.0
#> 29 wisdm 2.1.11
#> 30 wisdm 2.1.12
#> 31 wisdmStsimConnector 1.0.0
#> 32 wisdmStsimConnector 1.0.1
#> description
#> 1 Burn-P3+ package for burn probability modeling
#> 2 Burn-P3+ package for burn probability modeling
#> 3 Burn-P3+ package for burn probability modeling
#> 4 Cell2Fire fire growth model package for BurnP3+
#> 5 Cell2Fire fire growth model package for BurnP3+
#> 6 FireSTARR fire growth model package for BurnP3+
#> 7 FireSTARR fire growth model package for BurnP3+
#> 8 FireSTARR fire growth model package for BurnP3+
#> 9 Prometheus fire growth model package for BurnP3+
#> 10 Prometheus fire growth model package for BurnP3+
#> 11 Demo Sales SyncroSim Package
#> 12 Simulates demographics of wildlife populations
#> 13 ecoClassify package for image classification
#> 14 Example demonstrating how to create a SyncroSim package
#> 15 Example demonstrating how to create a SyncroSim package
#> 16 Example demonstrating how to use pipelines with an R model
#> 17 Example demonstrating how to use spatial data with an R model
#> 18 Example demonstrating how to use timesteps with an R model
#> 19 Example demonstrating how to use timesteps with a python model
#> 20 Example demonstrating how to use iterations with an R model
#> 21 Omni-directional habitat connectivity based on circuit theory
#> 22 Calculates changes in connectivity categories from a baseline
#> 23 Systematic conservation planning
#> 24 The ST-Sim state-and-transition simulation model
#> 25 The ST-Sim state-and-transition simulation model
#> 26 The ST-Sim state-and-transition simulation model
#> 27 Calculates TNC's unified ecological departure from reference conditions in ST-Sim
#> 28 Workbench for Integrated Species Distribution Modeling
#> 29 Workbench for Integrated Species Distribution Modeling
#> 30 Workbench for Integrated Species Distribution Modeling
#> 31 Connector package between WISDM and ST-Sim
#> 32 Connector package between WISDM and ST-Sim
#> url
#> 1 https://burnp3.github.io/BurnP3Plus/
#> 2 https://burnp3.github.io/BurnP3Plus/
#> 3 https://burnp3.github.io/BurnP3Plus/
#> 4 https://burnp3.github.io/BurnP3Plus/
#> 5 https://burnp3.github.io/BurnP3Plus/
#> 6 https://burnp3.github.io/BurnP3Plus/
#> 7 https://burnp3.github.io/BurnP3Plus/
#> 8 https://burnp3.github.io/BurnP3Plus/
#> 9 https://burnp3.github.io/BurnP3Plus/
#> 10 https://burnp3.github.io/BurnP3Plus/
#> 11 https://apexrms.github.io/demosales/
#> 12 https://apexrms.github.io/dgsim/
#> 13 https://apexrms.github.io/ecoClassify/
#> 14 https://apexrms.github.io/helloworld/
#> 15 https://apexrms.github.io/helloworld/
#> 16 https://apexrms.github.io/helloworldEnhanced/
#> 17 https://apexrms.github.io/helloworldEnhanced/
#> 18 https://apexrms.github.io/helloworldEnhanced/
#> 19 https://apexrms.github.io/helloworldEnhanced/
#> 20 https://apexrms.github.io/helloworldEnhanced/
#> 21 https://apexrms.github.io/omniscape/
#> 22 https://github.com/ApexRMS/omniscapeImpact
#> 23 https://apexrms.github.io/prioritizr
#> 24 https://docs.stsim.net/
#> 25 https://docs.stsim.net/
#> 26 https://docs.stsim.net/
#> 27 https://docs.stsim.net/
#> 28 https://apexrms.github.io/wisdm/
#> 29 https://apexrms.github.io/wisdm/
#> 30 https://apexrms.github.io/wisdm/
#> 31 https://apexrms.github.io/wisdm/
#> 32 https://apexrms.github.io/wisdm/
# Check the package(s) in your SsimLibrary
packages(myLibrary)
#> name description version schema
#> 1 core SyncroSim Core Package 3.1.3 3.1
#> 2 stsim The ST-Sim state-and-transition simulation model 4.3.5 4.3
#> status
#> 1 OK
#> 2 Warning - No metadata found for package 'stsim'. You may be able to avoid this warning by using a newer version of the package.
# }