chartId: Retrieves chartId of SyncroSim Chart

In syncrosim/rsyncrosim: The R Interface to 'SyncroSim'

Retrieves chartId of SyncroSim Chart

Description

Retrieves the Chart Id of a SyncroSim Chart.

Usage

chartId(ssimObject)

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

## S4 method for signature 'Chart'
chartId(ssimObject)

Arguments

ssimObject

Chart object

Value

An integer: chart id.

Examples

## Not run: 
# Set the file path and name of the new SsimLibrary
myLibraryName <- file.path(tempdir(), "testlib")

# Set the SyncroSim Session, SsimLibrary, and Project
mySession <- session()
myLibrary <- ssimLibrary(name = myLibraryName, 
                         session = mySession, 
                         packages = "stsim",
                         overwrite = TRUE) 
myProject <- project(myLibrary, project = "Definitions")

# Get the chart object corresponding to the chart called "My Chart"
myChart <- chart(myProject, chart = "My Chart")

# Get Chart ID for SyncroSim Chart
chartId(myChart)

## End(Not run)

syncrosim/rsyncrosim documentation built on Oct. 18, 2024, 1:29 a.m.