filepath: Retrieves the path to a SyncroSim object on disk

In rsyncrosim: The R Interface to 'SyncroSim'

Retrieves the path to a SyncroSim object on disk

Description

Retrieves the path to a SyncroSim Session-class, SsimLibrary-class, Project-class, Scenario-class, of Folder-class on disk.

Usage

filepath(ssimObject)

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

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

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

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

Arguments

ssimObject

Session-class, Project-class, SsimLibrary-class, or Folder-class object

Value

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

Examples

## Not run: 
# 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)

## End(Not run)

rsyncrosim documentation built on Nov. 7, 2025, 5:14 p.m.