addPackage: Adds package to SyncroSim Installation

Description Usage Arguments Value Examples

Description

This function installs a package to the SyncroSim Session. If only the package name is provided as input, the function queries the SyncroSim package server for the specified package. If a file path is provided as input, the function adds a package to SyncroSim from a local package file (ends in ".ssimpkg"). The list of SyncroSim packages can be found here.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
addPackage(name, session = NULL)

## S4 method for signature 'ANY,character'
addPackage(name, session = NULL)

## S4 method for signature 'ANY,missingOrNULL'
addPackage(name, session = NULL)

## S4 method for signature 'ANY,Session'
addPackage(name, session = NULL)

Arguments

name

character string. The name or file path of the package to install

session

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

Value

Invisibly returns TRUE upon success (i.e.successful install) and FALSE upon failure.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## Not run: 
# Create a new SyncroSim Session
mySession <- session()

# Add package from the package server
addPackage("stsim", session = mySession)

# Add package using a local file path
addPackage("c:/path/to/stsim.ssimpkg")

## End(Not run)

rsyncrosim documentation built on Oct. 28, 2021, 1:07 a.m.