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)
# List all installed packages
packages(mySession)
#> name version
#> 1 burnP3Plus 2.3.0
#> 2 burnP3PlusCell2Fire 2.2.0
#> 3 burnP3PlusFireSTARR 1.2.0
#> 4 burnP3PlusPrometheus 2.2.0
#> 5 demosales 2.1.0
#> 6 dgsim 3.1.0
#> 7 ecoClassify 1.1.0
#> 8 helloworld 2.1.0
#> 9 omniscape 2.2.0
#> 10 prioritizr 2.2.2
#> 11 stsim 4.3.8
#> 12 stsimecodep 4.1.0
#> 13 wisdm 2.2.0
#> description
#> 1 Burn probability modeling
#> 2 Cell2Fire fire growth model for BurnP3+
#> 3 FireSTARR fire growth model for BurnP3+
#> 4 Prometheus fire growth model for BurnP3+
#> 5 Demo Sales SyncroSim Package
#> 6 Simulates demographics of wildlife populations
#> 7 Image classifier using semantic image segmentation
#> 8 Example demonstrating how to create a package
#> 9 Omni-directional habitat connectivity based on circuit theory
#> 10 Systematic conservation planning
#> 11 The ST-Sim state-and-transition simulation model
#> 12 Calculates TNC's unified ecological departure from reference conditions in ST-Sim
#> 13 Workbench for Integrated Species Distribution Modeling
#> location
#> 1 C:\\Users\\birch\\AppData\\Local\\SyncroSim\\Packages\\burnP3Plus\\2.3.0
#> 2 C:\\Users\\birch\\AppData\\Local\\SyncroSim\\Packages\\burnP3PlusCell2Fire\\2.2.0
#> 3 C:\\Users\\birch\\AppData\\Local\\SyncroSim\\Packages\\burnP3PlusFireSTARR\\1.2.0
#> 4 C:\\Users\\birch\\AppData\\Local\\SyncroSim\\Packages\\burnP3PlusPrometheus\\2.2.0
#> 5 C:\\Users\\birch\\AppData\\Local\\SyncroSim\\Packages\\demosales\\2.1.0
#> 6 C:\\Users\\birch\\AppData\\Local\\SyncroSim\\Packages\\dgsim\\3.1.0
#> 7 C:\\Users\\birch\\AppData\\Local\\SyncroSim\\Packages\\ecoClassify\\1.1.0
#> 8 C:\\Users\\birch\\AppData\\Local\\SyncroSim\\Packages\\helloworld\\2.1.0
#> 9 C:\\Users\\birch\\AppData\\Local\\SyncroSim\\Packages\\omniscape\\2.2.0
#> 10 C:\\Users\\birch\\AppData\\Local\\SyncroSim\\Packages\\prioritizr\\2.2.2
#> 11 C:\\Users\\birch\\AppData\\Local\\SyncroSim\\Packages\\stsim\\4.3.8
#> 12 C:\\Users\\birch\\AppData\\Local\\SyncroSim\\Packages\\stsimecodep\\4.1.0
#> 13 C:\\Users\\birch\\AppData\\Local\\SyncroSim\\Packages\\wisdm\\2.2.0
#> status
#> 1 OK
#> 2 OK
#> 3 OK
#> 4 OK
#> 5 OK
#> 6 OK
#> 7 OK
#> 8 OK
#> 9 OK
#> 10 OK
#> 11 OK
#> 12 OK
#> 13 OK
# List all available packages on the server (including currently installed)
packages(installed = FALSE)
#> name version
#> 1 burnP3Plus 2.3.0
#> 2 burnP3PlusCell2Fire 2.2.0
#> 3 burnP3PlusFireSTARR 1.2.0
#> 4 burnP3PlusPrometheus 2.2.0
#> 5 demosales 2.1.0
#> 6 dgsim 3.1.0
#> 7 ecoClassify 1.1.0
#> 8 helloworld 2.1.0
#> 9 omniscape 2.2.0
#> 10 prioritizr 2.2.2
#> 11 stsim 4.3.8
#> 12 stsimecodep 4.1.0
#> 13 wisdm 2.2.0
#> description
#> 1 Burn-P3+ package for burn probability modeling
#> 2 Cell2Fire fire growth model package for BurnP3+
#> 3 FireSTARR fire growth model package for BurnP3+
#> 4 Prometheus fire growth model package for BurnP3+
#> 5 Demo Sales SyncroSim Package
#> 6 Simulates demographics of wildlife populations
#> 7 ecoClassify package for image classification
#> 8 Example demonstrating how to create a SyncroSim package
#> 9 Omni-directional habitat connectivity based on circuit theory
#> 10 Systematic conservation planning
#> 11 The ST-Sim state-and-transition simulation model
#> 12 Calculates TNC's unified ecological departure from reference conditions in ST-Sim
#> 13 Workbench for Integrated Species Distribution Modeling
#> 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://apexrms.github.io/demosales/
#> 6 https://apexrms.github.io/dgsim/
#> 7 https://apexrms.github.io/ecoClassify/
#> 8 https://apexrms.github.io/helloworld/
#> 9 https://apexrms.github.io/omniscape/
#> 10 https://apexrms.github.io/prioritizr
#> 11 https://docs.stsim.net/
#> 12 https://docs.stsim.net/
#> 13 https://apexrms.github.io/wisdm/
# Check the package(s) in your SsimLibrary
packages(myLibrary)
#> name description version schema status
#> 1 core SyncroSim Core Package 3.1.9 3.1 OK
#> 2 stsim The ST-Sim state-and-transition simulation model 4.3.8 4.3 OK
# }