Retrieves the packages installed or available for this version of SyncroSim.

package(ssimObject = NULL, installed = TRUE, listTemplates = NULL)

# S4 method for character
package(ssimObject = NULL, installed = TRUE, listTemplates = NULL)

# S4 method for missingOrNULL
package(ssimObject = NULL, installed = TRUE, listTemplates = NULL)

# S4 method for Session
package(ssimObject = NULL, installed = TRUE, listTemplates = NULL)

# S4 method for SsimLibrary
package(ssimObject)

Arguments

ssimObject

Session or SsimLibrary object. If NULL (default), session() will be used

installed

logical or character. TRUE (default) to list installed packages, FALSE to list available packages, and "BASE" to list installed base packages

listTemplates

character. Name of a SyncroSim package. If not NULL (default), then lists all templates available for that package. The package must be installed in the current Session. Ignored if ssimObject is a SsimLibrary object

Value

Returns a data.frame of packages installed or templates available for a specified package.

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
package(mySession)
#>                        name
#> 1                    burnP3
#> 2           burnp3basemodel
#> 3                burnP3Plus
#> 4       burnP3PlusCell2Fire
#> 5      burnP3PlusPrometheus
#> 6                 demosales
#> 7                  designer
#> 8                       epi
#> 9        epiModelVocVaccine
#> 10               helloworld
#> 11          helloworldConda
#> 12           helloworldOmni
#> 13       helloworldPipeline
#> 14        helloworldSpatial
#> 15   helloworldSpatialConda
#> 16 helloworldSpatialReports
#> 17           helloworldTime
#> 18    helloworldUncertainty
#> 19                  netlogo
#> 20                stconnect
#> 21                    stsim
#> 22             stsimcbmcfs3
#> 23                  stsimsf
#> 24                    wisdm
#>                                                                                                       description
#> 1                                                                   Burn-P3 package for burn probability modeling
#> 2                                                                                               BurnP3 base model
#> 3                                                                  Burn-P3+ package for burn probability modeling
#> 4                                                          Cell2Fire fire growth model add-on package for Burn-P3
#> 5                                                    Prometheus fire growth model add-on package for Burn-P3 Plus
#> 6                                                                               Demo Sales SyncroSim Base Package
#> 7                                                                                      SyncroSim Package Designer
#> 8                                                                         Model of epidemic infections and deaths
#> 9                                                                Integrates VOCs and vaccination in the Epi model
#> 10                                                                  Example demonstrating how to create a package
#> 11                                          Example demonstrating how to create a package with Conda environments
#> 12                                                                  Example demonstrating how to create a package
#> 13                                                                     Example demonstrating how to use pipelines
#> 14                                                                  Example demonstrating how to use spatial data
#> 15                                                                       Example demonstrating conda environments
#> 16                                                                  Example demonstrating how to use spatial data
#> 17                                                                     Example demonstrating how to use timesteps
#> 18                                                                    Example demonstrating how to use iterations
#> 19                                                              Runs the NetLogo agent-based modeling environment
#> 20                                                   Connectivity planning for future climate and land-use change
#> 21                                                               The ST-Sim state-and-transition simulation model
#> 22 Integrates the Carbon Budget Model for the Canadian Forest Sector (CBM-CFS3) into the ST-Sim simulation model.
#> 23                                                   Integrates stocks and flows into the ST-Sim simulation model
#> 24                                                         Workbench for Integrated Species Distribution Modeling
#>    version
#> 1    0.0.0
#> 2    0.0.0
#> 3    0.1.1
#> 4    0.1.1
#> 5    0.1.2
#> 6    1.1.0
#> 7    1.0.1
#> 8    1.1.3
#> 9    1.0.2
#> 10   1.0.1
#> 11   1.0.1
#> 12   1.0.1
#> 13   1.0.0
#> 14   1.0.4
#> 15   1.0.0
#> 16   1.0.3
#> 17   1.0.0
#> 18   1.0.0
#> 19   1.2.0
#> 20  1.1.16
#> 21   3.3.9
#> 22  1.0.14
#> 23  3.3.10
#> 24   1.0.0

# List all the installed base packages
package(installed = "BASE")
#>                        name
#> 1                    burnP3
#> 2                burnP3Plus
#> 3                 demosales
#> 4                  designer
#> 5                       epi
#> 6                helloworld
#> 7           helloworldConda
#> 8            helloworldOmni
#> 9        helloworldPipeline
#> 10        helloworldSpatial
#> 11   helloworldSpatialConda
#> 12 helloworldSpatialReports
#> 13           helloworldTime
#> 14    helloworldUncertainty
#> 15                  netlogo
#> 16                stconnect
#> 17                    stsim
#> 18                    wisdm
#>                                                              description
#> 1                          Burn-P3 package for burn probability modeling
#> 2                         Burn-P3+ package for burn probability modeling
#> 3                                      Demo Sales SyncroSim Base Package
#> 4                                             SyncroSim Package Designer
#> 5                                Model of epidemic infections and deaths
#> 6                          Example demonstrating how to create a package
#> 7  Example demonstrating how to create a package with Conda environments
#> 8                          Example demonstrating how to create a package
#> 9                             Example demonstrating how to use pipelines
#> 10                         Example demonstrating how to use spatial data
#> 11                              Example demonstrating conda environments
#> 12                         Example demonstrating how to use spatial data
#> 13                            Example demonstrating how to use timesteps
#> 14                           Example demonstrating how to use iterations
#> 15                     Runs the NetLogo agent-based modeling environment
#> 16          Connectivity planning for future climate and land-use change
#> 17                      The ST-Sim state-and-transition simulation model
#> 18                Workbench for Integrated Species Distribution Modeling
#>    version
#> 1    0.0.0
#> 2    0.1.1
#> 3    1.1.0
#> 4    1.0.1
#> 5    1.1.3
#> 6    1.0.1
#> 7    1.0.1
#> 8    1.0.1
#> 9    1.0.0
#> 10   1.0.4
#> 11   1.0.0
#> 12   1.0.3
#> 13   1.0.0
#> 14   1.0.0
#> 15   1.2.0
#> 16  1.1.16
#> 17   3.3.9
#> 18   1.0.0

# List all available packages on the server (including currently installed)
package(installed = FALSE)
#>                     name
#> 1              demosales
#> 2                  dgsim
#> 3                    epi
#> 4     epiModelVocVaccine
#> 5             helloworld
#> 6     helloworldPipeline
#> 7      helloworldSpatial
#> 8         helloworldTime
#> 9  helloworldUncertainty
#> 10     landfirevegmodels
#> 11                 lucas
#> 12               netlogo
#> 13             stconnect
#> 14                 stsim
#> 15          stsimcbmcfs3
#> 16           stsimecodep
#> 17               stsimsf
#>                                                                                                                               description
#> 1                                                                 Example SyncroSim Base Package of a very simple sales forecasting model
#> 2                                                                                          Simulates demographics of wildlife populations
#> 3                                                                                                 Model of epidemic infections and deaths
#> 4                                                                                      Integrates VOCs and vaccination into the Epi model
#> 5                                                                                           Example demonstrating how to create a package
#> 6                                                                                                                 Example using pipelines
#> 7                                                                                                              Example using spatial data
#> 8                                                                                                                 Example using timesteps
#> 9                                                                                       Example using iterations to represent uncertainty
#> 10                                                                                                             LANDFIRE vegetation models
#> 11                                                                                         Land Use and Carbon Scenario Simulator (LUCAS)
#> 12                                                                                      Runs the NetLogo agent-based modeling environment
#> 13                                                                           Connectivity planning for future climate and land-use change
#> 14                                                                                       The ST-Sim state-and-transition simulation model
#> 15                          Integrates the Carbon Budget Model for the Canadian Forest Sector (CBM-CFS3) into the ST-Sim simulation model
#> 16 Calculates ecological departure in ST-Sim using the LANDFIRE Fire Regime Condition Class [*** REQUIRES SyncroSim v2.2.3 or higher ***]
#> 17                                                                           Integrates stocks and flows into the ST-Sim simulation model
#>    version
#> 1    1.1.0
#> 2    2.3.0
#> 3    1.1.3
#> 4    1.0.2
#> 5    1.0.1
#> 6    1.0.0
#> 7    1.0.4
#> 8    1.0.0
#> 9    1.0.0
#> 10   1.1.1
#> 11   1.0.6
#> 12   1.2.0
#> 13  1.1.17
#> 14   3.3.9
#> 15  1.0.14
#> 16   3.3.1
#> 17   3.3.8
 
# Check the package you're SsimLibrary is currently using
package(myLibrary)
#>    name                                      description version
#> 1 stsim The ST-Sim state-and-transition simulation model   3.3.9

# Check the templates available for an installed package
addPackage("helloworldSpatial")
#> Package <helloworldSpatial> is already installed
package(listTemplates = "helloworldSpatial")
#>                                name     displayName installed
#> 1 helloworldSpatial_example-library example-library       Yes
# }