filepath: Retrieves the path to a SyncroSim object on disk

Description Usage Arguments Value Examples

Description

Retrieves the path to a SyncroSim Session, SsimLibrary, Project or Scenario on disk.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
filepath(ssimObject)

## S4 method for signature 'character'
filepath(ssimObject)

## S4 method for signature 'Session'
filepath(ssimObject)

## S4 method for signature 'SsimObject'
filepath(ssimObject)

Arguments

ssimObject

Session, Project, or SsimLibrary object

Value

A character string: the path to a SyncroSim object on disk.

Examples

1
2
3
4
5
6
7
8
9
# Specify file path and name of new SsimLibrary
myLibraryName <- file.path(tempdir(), "testlib")

# Set up a SyncroSim Session and SsimLibrary
mySession <- session()
myLibrary <- ssimLibrary(name = myLibraryName, session = mySession)

# Get the file path
myFilePath <- filepath(myLibrary)

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