published: Publication status of a SyncroSim Folder

In rsyncrosim: The R Interface to 'SyncroSim'

Publication status of a SyncroSim Folder

Description

Retrieves or sets the publication status of a SyncroSim Folder. Note that only one folder can be tagged for publication at a time, so if the publication status of a Folder is set to TRUE, then all other Folders will have publication status set to FALSE.

Usage

published(folder)

## S4 method for signature 'character'
published(folder)

## S4 method for signature 'Folder'
published(folder)

published(folder) <- value

## S4 replacement method for signature 'character'
published(folder) <- value

## S4 replacement method for signature 'Folder'
published(folder) <- value

Arguments

folder	Folder object
value	logical. If TRUE the Folder will be tagged for publication and all other Folders will have publication status set to FALSE. Default is FALSE

Value

A logical: TRUE if the Folder is tagged for publication and FALSE otherwise.

Examples

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

# Set up a SyncroSim Session, SsimLibrary, Project, and Scenario
mySession <- session()
myLibrary <- ssimLibrary(name = myLibraryName, session = mySession)
myProject <- project(myLibrary, project = "Definitions")
myFolder <- folder(myProject, folder = "New Folder")

# Retrieve publication status of the Folder
published(myFolder)

# Set the publication status of the Folder
published(myFolder) <- TRUE

## End(Not run)

rsyncrosim documentation built on Oct. 7, 2023, 9:08 a.m.