Publication status of a SyncroSim Folder — published • rsyncrosim

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.

published(folder)

# S4 method for character
published(folder)

# S4 method for Folder
published(folder)

published(folder) <- value

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

# S4 method for 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

# \donttest{
# 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)
#> [1] FALSE

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