diff --git a/DESCRIPTION b/DESCRIPTION index 5783aa15..dc5696ee 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -34,8 +34,7 @@ Imports: DBI, RSQLite, terra, - gtools, - lifecycle + gtools Suggests: knitr, testthat (>= 3.0.0), diff --git a/R/chartCriteria.R b/R/chartCriteria.R index 5f2afa3e..68bb6ccd 100644 --- a/R/chartCriteria.R +++ b/R/chartCriteria.R @@ -73,6 +73,13 @@ setMethod("chartCriteria", signature(ssimObject = "SsimObject"), returnSingleChart <- (is(ssimObject, "Chart") || !is.null(chart)) && (is.null(variable)) returnAllChart <- (is(ssimObject, "Project") || !is.null(variable)) + + # Grab list of chart information for project to match names + if (is(ssimObject, "Project")){ + ssimProj <- ssimObject + } else { + ssimProj <- .project(ssimObject) + } if (returnSingleChart){ @@ -111,13 +118,6 @@ setMethod("chartCriteria", signature(ssimObject = "SsimObject"), df <- rbind(df, xResult) } - # Grab list of chart information for project to match names - if (is(ssimObject, "Project")){ - ssimProj <- ssimObject - } else { - ssimProj <- .project(ssimObject) - } - # dissagregateBy should match filter values in projectchartCriteria for (i in 1:nrow(df)){ @@ -189,7 +189,7 @@ setMethod("chartCriteria", signature(ssimObject = "SsimObject"), chartDS <- subsetInfo$datasheet args <- list(list = NULL, columns = NULL, lib=libPath, allprops = NULL, sheet = chartDS, csv = NULL) - tt <- command(args, mySession) + tt <- command(args, chartSession) df <- .dataframeFromSSim(tt) df_filtered <- df[df$name %in% filter, ] @@ -198,7 +198,7 @@ setMethod("chartCriteria", signature(ssimObject = "SsimObject"), } displayNameDS <- gsub(".*formula1\\^(.+)\\!formula2.*", "\\1", df_filtered$properties) - valuesDS <- .datasheet(myProject, name = displayNameDS, rawValues = T, includeKey = T) + valuesDS <- .datasheet(ssimProj, name = displayNameDS, rawValues = T, includeKey = T) names(valuesDS) <- c("ID", "Name") return(valuesDS[1:2]) } diff --git a/R/chartId.R b/R/chartId.R index 2590edb9..874dbb32 100644 --- a/R/chartId.R +++ b/R/chartId.R @@ -7,7 +7,7 @@ NULL #' #' Retrieves the Chart Id of a SyncroSim \code{\link{Chart}}. #' -#' @param chart \code{\link{Chart}} object +#' @param ssimObject \code{\link{Chart}} object #' #' @return #' An integer: chart id. diff --git a/R/datasheet.R b/R/datasheet.R index 37a7959e..563e64b0 100644 --- a/R/datasheet.R +++ b/R/datasheet.R @@ -251,7 +251,8 @@ setMethod("datasheet", ParentId <- NULL ParentName <- NULL Name <- NULL - xProjScn <- .getFromXProjScn(ssimObject, project, scenario, returnIds = TRUE, convertObject = FALSE, complainIfMissing = TRUE) + xProjScn <- .getFromXProjScn(ssimObject, project, scenario, returnIds = TRUE, + convertObject = FALSE, complainIfMissing = TRUE) IDColumns <- c("ScenarioId", "ProjectId") if (is(ssimObject, "SsimLibrary")){ @@ -341,7 +342,7 @@ setMethod("datasheet", sumInfo <- subset(sumInfo, select = c("scope", "name", "displayName", "order")) sumInfo[order(sumInfo$order), ] sumInfo$order <- NULL - sumInfo <- subset(sumInfo, scope == scopeDS) + sumInfo <- sumInfo[sumInfo$scope == scopeDS,] return(sumInfo) } @@ -356,7 +357,7 @@ setMethod("datasheet", sumInfo[order(sumInfo$order), ] sumInfo$order <- NULL - sumInfo <- subset(sumInfo, scope == scopeDS) + sumInfo <- sumInfo[sumInfo$scope == scopeDS,] return(sumInfo) } @@ -398,7 +399,7 @@ setMethod("datasheet", sumInfo <- subset(sumInfo, select = c(prevNames, setdiff(names(sumInfo), prevNames))) sumInfo <- sumInfo[order(sumInfo$order, sumInfo$scenario), ] sumInfo$order <- NULL - sumInfo <- subset(sumInfo, scope == scopeDS) + sumInfo <- sumInfo[sumInfo$scope == scopeDS,] return(sumInfo) } diff --git a/R/delete.R b/R/delete.R index 05eab4a4..3f0b4e90 100644 --- a/R/delete.R +++ b/R/delete.R @@ -105,6 +105,9 @@ setMethod("delete", signature(ssimObject = "SsimObject"), force, session) { ScenarioId <- NULL + Name <- NULL + FolderId <- NULL + ChartId <- NULL xProjScn <- .getFromXProjScn(ssimObject, project = project, scenario = scenario, folder = folder, @@ -115,7 +118,7 @@ setMethod("delete", signature(ssimObject = "SsimObject"), if (is.null(folder)) { folderId <- .folderId(ssimObject) - folderName <- .name(ssimobject) + folderName <- .name(ssimObject) } else { allFolders <- getFolderData(ssimObject) diff --git a/R/deleteLibrary.R b/R/deleteLibrary.R index ddd2fd18..4a5753d3 100644 --- a/R/deleteLibrary.R +++ b/R/deleteLibrary.R @@ -1,3 +1,8 @@ +# Copyright (c) 2024 Apex Resource Management Solution Ltd. (ApexRMS). All rights reserved. +# MIT License +#' @include AAAClassDefinitions.R +NULL + #' Delete Library #' #' Deletes a SyncroSim library. Note this is irreversable. @@ -38,11 +43,13 @@ #' #' @export +#' @rdname deleteLibrary setGeneric("deleteLibrary", function(ssimLibrary, force = FALSE, removeBackup = FALSE, removePublish = FALSE, removeCustom = FALSE, session = NULL) standardGeneric("deleteLibrary")) +#' @rdname deleteLibrary setMethod("deleteLibrary", signature(ssimLibrary = "SsimLibrary"), function(ssimLibrary, force, removeBackup, removePublish, removeCustom) { @@ -50,6 +57,7 @@ setMethod("deleteLibrary", signature(ssimLibrary = "SsimLibrary"), removePublish, removeCustom, .session(ssimLibrary))) }) +#' @rdname deleteLibrary setMethod("deleteLibrary", signature(ssimLibrary = "character"), function(ssimLibrary, force, removeBackup, removePublish, removeCustom, session) { diff --git a/R/dependency.R b/R/dependency.R index 4512f602..5c46fa39 100644 --- a/R/dependency.R +++ b/R/dependency.R @@ -23,10 +23,13 @@ NULL #' If the dependency argument includes more than one element, elements are ordered #' from lowest to highest precedence. #' -#' @param scenario \code{\link{Scenario}} object, character string, integer, or +#' @param ssimObject \code{\link{Scenario}} object, character string, integer, or #' vector of these. The Scenario object, name, or ID to which a dependency is to #' be added (or has already been added if \code{remove=TRUE}). Note that integer ids -#' are slightly faster +#' are slightly faster. +#' @param value \code{\link{Scenario}} object, character string, integer, or +#' vector of these. The Scenario object, name, or ID to be used as the +#' dependency. If an empty vector is provided, all dependencies are removed. #' #' @return #' A data.frame: all dependencies for a given Scenario @@ -55,18 +58,18 @@ NULL #' } #' #' @export -setGeneric("dependency", function(scenario) standardGeneric("dependency")) +setGeneric("dependency", function(ssimObject) standardGeneric("dependency")) #' @rdname dependency -setMethod("dependency", signature(scenario = "character"), function(scenario) { - return(SyncroSimNotFound(scenario)) +setMethod("dependency", signature(ssimObject = "character"), function(ssimObject) { + return(SyncroSimNotFound(ssimObject)) }) #' @rdname dependency -setMethod("dependency", signature(scenario = "Scenario"), function(scenario) { +setMethod("dependency", signature(ssimObject = "Scenario"), function(ssimObject) { - # Rename variable so it's not the same as the rsyncrosim::scenario() function - s <- scenario + # Rename variable + s <- ssimObject # get set of existing dependencies args <- list(list = NULL, dependencies = NULL, lib = .filepath(s), @@ -121,9 +124,11 @@ setReplaceMethod( cDep <- allScns$ScenarioId[allScns$Name == v] if (length(cDep) == 0) { - stop("Could not find dependency scenario ", cDepRaw) + stop("Could not find dependency scenario ", v) } else if (length(cDep) > 1) { - stop("Found more than one scenario named ", v, ". Please specify a dependency scenario id:", paste0(v, collapse = ",")) + stop("Found more than one scenario named ", v, + ". Please specify a dependency scenario id:", + paste0(v, collapse = ",")) } else { valueList <- c(valueList, cDep) } diff --git a/R/folder.R b/R/folder.R index accda6f3..d05c95b3 100644 --- a/R/folder.R +++ b/R/folder.R @@ -10,6 +10,7 @@ setMethod( Name <- NULL FolderId <- NULL + ProjectId <- NULL x <- ssimObject # Set default parent ID @@ -184,6 +185,9 @@ folder <- function(ssimObject = NULL, folder = NULL, parentFolder = NULL, stop("Cannot create a folder at the Scenario-level.") } + FolderId <- NULL + Name <- NULL + x <- ssimObject if (is(ssimObject, "Folder") & (summary == TRUE)){ diff --git a/R/internalHelpers.R b/R/internalHelpers.R index d26173ab..fe6fdcca 100644 --- a/R/internalHelpers.R +++ b/R/internalHelpers.R @@ -211,6 +211,8 @@ deleteScenarioDatasheet <- function(x, datasheet, scenario, deleteScenario <- function(x, scenario, allScenarios, out = list(), force){ + ScenarioId <- NULL + for (i in seq(length.out = length(scenario))) { cScn <- scenario[i] name <- allScenarios$Name[allScenarios$ScenarioId == cScn] diff --git a/R/packages.R b/R/packages.R index e46e4f20..f6b3157e 100644 --- a/R/packages.R +++ b/R/packages.R @@ -59,6 +59,8 @@ setMethod("packages", signature(ssimObject = "missingOrNULL"), setMethod("packages", signature(ssimObject = "Session"), function(ssimObject, installed = TRUE) { + Name <- NULL + if (installed == FALSE) { arg <- "available" } else { diff --git a/R/projectId.R b/R/projectId.R index 12fc59fe..e11114a4 100644 --- a/R/projectId.R +++ b/R/projectId.R @@ -9,7 +9,7 @@ NULL #' \code{\link{Scenario}}, \code{\link{Folder}} or \code{\link{Chart}}. #' #' @param ssimObject \code{\link{Scenario}}, \code{\link{Project}}, -#' \code{\link{Folder}}, or \code{\link{{Chart}}} object +#' \code{\link{Folder}}, or \code{\link{Chart}} object #' #' @return #' An integer: project id. diff --git a/R/run.R b/R/run.R index 995bf47b..56c5c7c7 100644 --- a/R/run.R +++ b/R/run.R @@ -91,7 +91,8 @@ setMethod("run", signature(ssimObject = "list"), setMethod("run", signature(ssimObject = "SsimObject"), function(ssimObject, scenario, summary, copyExternalInputs, transformerName) { - + + ScenarioId <- NULL xProjScn <- .getFromXProjScn(ssimObject, scenario = scenario, convertObject = TRUE, returnIds = TRUE, goal = "scenario", complainIfMissing = TRUE) diff --git a/man/addPackage.Rd b/man/addPackage.Rd index 9ca34d1f..ec99e1d3 100644 --- a/man/addPackage.Rd +++ b/man/addPackage.Rd @@ -32,7 +32,7 @@ of the package) or \code{FALSE} upon failure. Adds package(s) to a \code{\link{SsimLibrary}}. } \examples{ -\donttest{ +\dontrun{ # Install "stsim" and "stsimecodep" SyncroSim packages installPackage(packages = c("stsim", "stsim"), versions = c("4.0.0", "4.0.1")) diff --git a/man/backup.Rd b/man/backup.Rd index 2a61cc9d..3b77c62c 100644 --- a/man/backup.Rd +++ b/man/backup.Rd @@ -26,7 +26,7 @@ SyncroSim User Interface, but is by default at the same level as the SsimLibrary file, and is called libraryName.backup. } \examples{ -\donttest{ +\dontrun{ # Specify file path and name of new SsimLibrary myLibraryName <- file.path(tempdir(), "testlib") diff --git a/man/chart.Rd b/man/chart.Rd index 1cf26577..ff935fb3 100644 --- a/man/chart.Rd +++ b/man/chart.Rd @@ -34,7 +34,7 @@ Create or open a \code{\link{Chart}} from a SyncroSim \code{\link{Project}}. } \examples{ -\donttest{ +\dontrun{ # Set the file path and name of the new SsimLibrary myLibraryName <- file.path(tempdir(),"testlib") diff --git a/man/chartId.Rd b/man/chartId.Rd index c3a9f532..b653e271 100644 --- a/man/chartId.Rd +++ b/man/chartId.Rd @@ -13,7 +13,7 @@ chartId(ssimObject) \S4method{chartId}{Chart}(ssimObject) } \arguments{ -\item{chart}{\code{\link{Chart}} object} +\item{ssimObject}{\code{\link{Chart}} object} } \value{ An integer: chart id. @@ -22,7 +22,7 @@ An integer: chart id. Retrieves the Chart Id of a SyncroSim \code{\link{Chart}}. } \examples{ -\donttest{ +\dontrun{ # Set the file path and name of the new SsimLibrary myLibraryName <- file.path(tempdir(), "testlib") diff --git a/man/datasheet.Rd b/man/datasheet.Rd index 124408ac..eb71a240 100644 --- a/man/datasheet.Rd +++ b/man/datasheet.Rd @@ -246,7 +246,9 @@ myDatasheet <- datasheet(myScenario, name = "helloworldSpatial_RunControl", myDatasheet$helloworldSpatial_RunControl # Get a Datasheet without pre-specified values -myDatasheetEmpty <- datasheet(myScenario, name = "RunControl", empty = TRUE) +myDatasheetEmpty <- datasheet(myScenario, + name = "helloworldSpatial_RunControl", + empty = TRUE) # If Datasheet is empty, do not return dependencies as factors myDatasheetEmpty <- datasheet(myScenario, diff --git a/man/delete.Rd b/man/delete.Rd index 33adb0c3..c0117970 100644 --- a/man/delete.Rd +++ b/man/delete.Rd @@ -89,7 +89,7 @@ input: \code{TRUE} upon success (i.e.successful deletion) and \code{FALSE} upon Deletes one or more items. Note that this is irreversible. } \examples{ -\donttest{ +\dontrun{ # Specify file path and name of new SsimLibrary myLibraryName <- file.path(tempdir(), "testlib") diff --git a/man/deleteLibrary.Rd b/man/deleteLibrary.Rd index dddf6ee2..81e57f05 100644 --- a/man/deleteLibrary.Rd +++ b/man/deleteLibrary.Rd @@ -2,6 +2,8 @@ % Please edit documentation in R/deleteLibrary.R \name{deleteLibrary} \alias{deleteLibrary} +\alias{deleteLibrary,SsimLibrary-method} +\alias{deleteLibrary,character-method} \title{Delete Library} \usage{ deleteLibrary( @@ -12,6 +14,17 @@ deleteLibrary( removeCustom = FALSE, session = NULL ) + +\S4method{deleteLibrary}{SsimLibrary}(ssimLibrary, force, removeBackup, removePublish, removeCustom) + +\S4method{deleteLibrary}{character}( + ssimLibrary, + force = FALSE, + removeBackup = FALSE, + removePublish = FALSE, + removeCustom = FALSE, + session = NULL +) } \arguments{ \item{ssimLibrary}{SsimLibrary or path to a library} @@ -35,9 +48,12 @@ is FALSE.} } \value{ "saved" or failure message. - -#' @examples -\donttest{ +} +\description{ +Deletes a SyncroSim library. Note this is irreversable. +} +\examples{ +\dontrun{ # Specify file path and name of new SsimLibrary myLibraryName <- file.path(tempdir(), "testlib") @@ -54,7 +70,5 @@ myLibrary <- ssimLibrary(name = myLibraryName, session = mySession) # Delete library from path deleteLibrary(myLibraryName) } -} -\description{ -Deletes a SyncroSim library. Note this is irreversable. + } diff --git a/man/dependency.Rd b/man/dependency.Rd index 57c281fb..d6188bc1 100644 --- a/man/dependency.Rd +++ b/man/dependency.Rd @@ -8,21 +8,25 @@ \alias{dependency<-,Scenario-method} \title{Get, set or remove Scenario dependency(s)} \usage{ -dependency(scenario) +dependency(ssimObject) -\S4method{dependency}{character}(scenario) +\S4method{dependency}{character}(ssimObject) -\S4method{dependency}{Scenario}(scenario) +\S4method{dependency}{Scenario}(ssimObject) dependency(ssimObject) <- value \S4method{dependency}{Scenario}(ssimObject) <- value } \arguments{ -\item{scenario}{\code{\link{Scenario}} object, character string, integer, or +\item{ssimObject}{\code{\link{Scenario}} object, character string, integer, or vector of these. The Scenario object, name, or ID to which a dependency is to be added (or has already been added if \code{remove=TRUE}). Note that integer ids -are slightly faster} +are slightly faster.} + +\item{value}{\code{\link{Scenario}} object, character string, integer, or +vector of these. The Scenario object, name, or ID to be used as the +dependency. If an empty vector is provided, all dependencies are removed.} } \value{ A data.frame: all dependencies for a given Scenario @@ -46,7 +50,7 @@ If the dependency argument includes more than one element, elements are ordered from lowest to highest precedence. } \examples{ -\donttest{ +\dontrun{ # Specify file path and name of new SsimLibrary myLibraryName <- file.path(tempdir(), "testlib") diff --git a/man/description.Rd b/man/description.Rd index ec4441ea..0bb268db 100644 --- a/man/description.Rd +++ b/man/description.Rd @@ -35,7 +35,7 @@ Get or set the description of a \code{\link{SsimLibrary}}, \code{\link{Project}} or \code{\link{Scenario}}. } \examples{ -\donttest{ +\dontrun{ # Specify file path and name of new SsimLibrary myLibraryName <- file.path(tempdir(), "testlib") diff --git a/man/filepath.Rd b/man/filepath.Rd index 67a71253..d30076a0 100644 --- a/man/filepath.Rd +++ b/man/filepath.Rd @@ -31,7 +31,7 @@ Retrieves the path to a SyncroSim \code{\link{Session}}, of \code{\link{Folder}} on disk. } \examples{ -\donttest{ +\dontrun{ # Specify file path and name of new SsimLibrary myLibraryName <- file.path(tempdir(), "testlib") diff --git a/man/folder.Rd b/man/folder.Rd index 121c09c3..1b0b07c3 100644 --- a/man/folder.Rd +++ b/man/folder.Rd @@ -43,7 +43,7 @@ Create or open a \code{\link{Folder}} from a SyncroSim \code{\link{Project}}. } \examples{ -\donttest{ +\dontrun{ # Set the file path and name of the new SsimLibrary myLibraryName <- file.path(tempdir(),"testlib") diff --git a/man/folderId.Rd b/man/folderId.Rd index 52edf346..4980379e 100644 --- a/man/folderId.Rd +++ b/man/folderId.Rd @@ -37,7 +37,7 @@ Retrieves the Folder Id of a SyncroSim \code{\link{Folder}} or desired folder in the SyncroSim User Interface. } \examples{ -\donttest{ +\dontrun{ # Set the file path and name of the new SsimLibrary myLibraryName <- file.path(tempdir(),"testlib") diff --git a/man/ignoreDependencies.Rd b/man/ignoreDependencies.Rd index a1b249e9..f1db34fc 100644 --- a/man/ignoreDependencies.Rd +++ b/man/ignoreDependencies.Rd @@ -34,7 +34,7 @@ A character string: Scenario Datafeeds that will be ignored. Retrieves or sets the Datafeeds to ignore for a \code{\link{Scenario}}. } \examples{ -\donttest{ +\dontrun{ # Specify file path and name of new SsimLibrary myLibraryName <- file.path(tempdir(), "testlib") diff --git a/man/mergeDependencies.Rd b/man/mergeDependencies.Rd index a135a921..c8a9d1fa 100644 --- a/man/mergeDependencies.Rd +++ b/man/mergeDependencies.Rd @@ -36,7 +36,7 @@ Retrieves or sets whether or not a \code{\link{Scenario}} is configured to merge dependencies at run time. } \examples{ -\donttest{ +\dontrun{ # Specify file path and name of new SsimLibrary myLibraryName <- file.path(tempdir(),"testlib") diff --git a/man/name.Rd b/man/name.Rd index 60565656..d5aebdf2 100644 --- a/man/name.Rd +++ b/man/name.Rd @@ -59,7 +59,7 @@ Retrieves or sets the name of a \code{\link{SsimLibrary}}, \code{\link{Project}}, \code{\link{Scenario}}, or \code{\link{Folder}}. } \examples{ -\donttest{ +\dontrun{ # Specify file path and name of new SsimLibrary myLibraryName <- file.path(tempdir(), "testlib") diff --git a/man/packages.Rd b/man/packages.Rd index 3777945e..086b62e5 100644 --- a/man/packages.Rd +++ b/man/packages.Rd @@ -36,7 +36,7 @@ called on a \code{\link{Session}} object, or the packages added to a SyncroSim Library if called on a \code{\link{SsimLibrary}} object. } \examples{ -\donttest{ +\dontrun{ # Set the file path and name of the new SsimLibrary myLibraryName <- file.path(tempdir(),"testlib") diff --git a/man/printCmd.Rd b/man/printCmd.Rd index af2a73b2..333018c6 100644 --- a/man/printCmd.Rd +++ b/man/printCmd.Rd @@ -26,7 +26,7 @@ Retrieves a printCmd setting of a \code{\link{Session}} object. The printCmd setting configures a Session for printing commands sent to the console. } \examples{ -\donttest{ +\dontrun{ # Set SyncroSim Session mySession <- session() diff --git a/man/project.Rd b/man/project.Rd index 9f372d49..d05f099d 100644 --- a/man/project.Rd +++ b/man/project.Rd @@ -54,7 +54,7 @@ named element. Note that SyncroSim automatically assigns an id to a new Project. } } \examples{ -\donttest{ +\dontrun{ # Set the file path and name of the new SsimLibrary myLibraryName <- file.path(tempdir(),"testlib_project") diff --git a/man/projectId.Rd b/man/projectId.Rd index 07712ab9..887233fa 100644 --- a/man/projectId.Rd +++ b/man/projectId.Rd @@ -23,7 +23,7 @@ projectId(ssimObject) } \arguments{ \item{ssimObject}{\code{\link{Scenario}}, \code{\link{Project}}, -\code{\link{Folder}}, or \code{\link{{Chart}}} object} +\code{\link{Folder}}, or \code{\link{Chart}} object} } \value{ An integer: project id. @@ -33,7 +33,7 @@ Retrieves the projectId of a SyncroSim \code{\link{Project}}, \code{\link{Scenario}}, \code{\link{Folder}} or \code{\link{Chart}}. } \examples{ -\donttest{ +\dontrun{ # Set the file path and name of the new SsimLibrary myLibraryName <- file.path(tempdir(),"testlib") diff --git a/man/readOnly.Rd b/man/readOnly.Rd index f3b90fe7..4ecc10b3 100644 --- a/man/readOnly.Rd +++ b/man/readOnly.Rd @@ -56,7 +56,7 @@ Retrieves or sets whether or not a \code{\link{SsimLibrary}}, read-only. } \examples{ -\donttest{ +\dontrun{ # Specify file path and name of new SsimLibrary myLibraryName <- file.path(tempdir(), "testlib") diff --git a/man/removePackage.Rd b/man/removePackage.Rd index 9ed219e0..b58c069f 100644 --- a/man/removePackage.Rd +++ b/man/removePackage.Rd @@ -25,7 +25,7 @@ removal of the package) or \code{FALSE} upon failure. Removes package(s) from a \code{\link{SsimLibrary}}. } \examples{ -\donttest{ +\dontrun{ # Install "stsim" and "stsimecodep" SyncroSim packages installPackage("stsim") installPackage("stsimecodep") diff --git a/man/rsyncrosim.Rd b/man/rsyncrosim.Rd index 1c8a53c2..28b8e888 100644 --- a/man/rsyncrosim.Rd +++ b/man/rsyncrosim.Rd @@ -20,7 +20,7 @@ To learn more about rsyncrosim, start with the vignette tutorial: \seealso{ Useful links: \itemize{ - \item \url{} + \item \url{https://syncrosim.github.io/rsyncrosim/} \item Report bugs at \url{https://github.com/syncrosim/rsyncrosim/issues/} } diff --git a/man/scenario.Rd b/man/scenario.Rd index 08f02d68..bc128ba4 100644 --- a/man/scenario.Rd +++ b/man/scenario.Rd @@ -75,7 +75,7 @@ a copy of sourceScenario. } } \examples{ -\donttest{ +\dontrun{ # Set the file path and name of the new SsimLibrary myLibraryName <- file.path(tempdir(),"testlib") diff --git a/man/scenarioId.Rd b/man/scenarioId.Rd index b1762056..5be36f6e 100644 --- a/man/scenarioId.Rd +++ b/man/scenarioId.Rd @@ -22,7 +22,7 @@ Integer id of the input Scenario. Retrieves the scenarioId of a \code{\link{Scenario}}. } \examples{ -\donttest{ +\dontrun{ # Set the file path and name of the new SsimLibrary myLibraryName <- file.path(tempdir(),"testlib") diff --git a/man/session.Rd b/man/session.Rd index 987508a8..e16dcd14 100644 --- a/man/session.Rd +++ b/man/session.Rd @@ -55,7 +55,7 @@ have updated the SyncroSim software and want to update an existing SsimObject to use the new software. } \examples{ -\donttest{ +\dontrun{ # Specify file path and name of new SsimLibrary myLibraryName <- file.path(tempdir(), "testlib") diff --git a/man/silent.Rd b/man/silent.Rd index 54ad8435..db96dfc5 100644 --- a/man/silent.Rd +++ b/man/silent.Rd @@ -36,7 +36,7 @@ Checks or sets whether a SyncroSim \code{\link{Session}} is silent or not. In a silent session, warnings from the console are ignored. } \examples{ -\donttest{ +\dontrun{ # Set up a SyncroSim Session mySession <- session() diff --git a/man/sqlStatement.Rd b/man/sqlStatement.Rd index 13642723..6f9089e0 100644 --- a/man/sqlStatement.Rd +++ b/man/sqlStatement.Rd @@ -40,7 +40,7 @@ Note that it is not possible to construct a complete SQL query at this stage, because the \code{\link{datasheet}} function may add ScenarioId and/or ProjectId to the query. } \examples{ -\donttest{ +\dontrun{ # Query total Amount for each combination of ScenarioId, Iteration, Timestep and StateLabelXID, # including only Timesteps 0,1 and 2, and Iterations 3 and 4. mySQL <- sqlStatement( diff --git a/man/ssimLibrary.Rd b/man/ssimLibrary.Rd index ba4ba9bc..746b00e2 100644 --- a/man/ssimLibrary.Rd +++ b/man/ssimLibrary.Rd @@ -86,7 +86,7 @@ of package. } } \examples{ -\donttest{ +\dontrun{ # Make sure packages are installed installPackage("stsim") diff --git a/man/tempfilepath.Rd b/man/tempfilepath.Rd index f5547413..5dbfebf0 100644 --- a/man/tempfilepath.Rd +++ b/man/tempfilepath.Rd @@ -28,7 +28,7 @@ Retrieves the temporary file path to a SyncroSim \code{\link{Session}}, on disk. } \examples{ -\donttest{ +\dontrun{ # Specify file path and name of new SsimLibrary myLibraryName <- file.path(tempdir(), "testlib") diff --git a/man/uninstallPackage.Rd b/man/uninstallPackage.Rd index 87f7ade3..764aad83 100644 --- a/man/uninstallPackage.Rd +++ b/man/uninstallPackage.Rd @@ -34,7 +34,7 @@ removal) and \code{FALSE} upon failure. Removes a package from SyncroSim installation } \examples{ -\donttest{ +\dontrun{ # Set SyncroSim session mySession <- session() diff --git a/man/version.Rd b/man/version.Rd index 3946cce9..716da168 100644 --- a/man/version.Rd +++ b/man/version.Rd @@ -25,7 +25,7 @@ A character string e.g. "2.2.13". Retrieves the version of a SyncroSim Session. } \examples{ -\donttest{ +\dontrun{ # Set SyncroSim Session mySession <- session()