chart: Create or open a chart

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

Create or open a chart

Description

Create or open a Chart from a SyncroSim Project.

Usage

chart(ssimObject = NULL, chart = NULL, create = FALSE, summary = FALSE)

Arguments

ssimObject	Project or Scenario object
chart	character or integer. If character, then will either open an existing chart if create=FALSE, or will create a new chart with the given name if the chart does not exist yet or create=TRUE. If integer, will open the existing chart with the given chart ID (if the ID exists). If no value is provided and create=TRUE, a new chart will be created with the default naming convention (e.g. "_Chart1", "_Chart2")
create	logical. Whether to create a new chart if the chart name given already exists in the SyncroSim library. If FALSE (Default), then will return the existing chart with the given name. If TRUE, then will return a new chart with the same name as an existing chart (but different chart ID)
summary	logical. If TRUE, returns a summary of chart information as an R data.frame. If FALSE (Default), then returns a SyncroSim Chart object

Value

A Chart object representing a SyncroSim chart

Examples

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

# Set the SyncroSim Session, SsimLibrary, Project, and Scenario
mySession <- session()
myLibrary <- ssimLibrary(name = myLibraryName, 
                         session = mySession,
                         packages = "stsim") 
myProject <- project(myLibrary, project = "My Project")
myScenario <- scenario(myProject, scenario = "My Scenario")

# Create a new chart
myChart <- chart(myProject, chart = "New Chart")

## End(Not run)

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