Renamed addPackage to installPackage

DESCRIPTION

@@ -46,7 +46,7 @@ Suggests:
 SystemRequirements: SyncroSim (>=2.3.10)
 Collate: 
     'AAAClassDefinitions.R'
-    'addPackage.R'
+    'installPackage.R'
     'addRow.R'
     'addon.R'
     'autogentags.R'

NAMESPACE

@@ -20,8 +20,8 @@ export(Session)
 export(SsimLibrary)
 export(addBreakpoint)
 export(addModule)
-export(addPackage)
-export(addPackageFile)
+export(installPackage)
+export(installPackageFile)
 export(addRow)
 export(addon)
 export(autogentags)

R/addon.R

@@ -25,7 +25,7 @@ NULL
 #' @examples
 #' \donttest{
 #' # Install the base package "stsim"
-#' addPackage("stsim")
+#' installPackage("stsim")
 #' 
 #' # Set the file path and name of the new SsimLibrary
 #' myLibraryName <- file.path(tempdir(),"testlib")

R/breakpoint.R

@@ -224,7 +224,7 @@ getBPNameLongForm <- function(breakpointType) {
 #' }
 #' 
 #' # Install helloworldSpatial package
-#' addPackage("helloworldSpatial")
+#' installPackage("helloworldSpatial")
 #' 
 #' # Set SsimLibrary name
 #' myLibraryName <- file.path(tempdir(),"testlib")
@@ -290,7 +290,7 @@ setMethod("addBreakpoint", signature(x = "Scenario"), function(x, transformerNam
 #' }
 #' 
 #' # Install helloworldSpatial package
-#' addPackage("helloworldSpatial")
+#' installPackage("helloworldSpatial")
 #' 
 #' # Set SsimLibrary name
 #' myLibraryName <- file.path(tempdir(),"testlib")
@@ -369,7 +369,7 @@ setMethod("deleteBreakpoint", signature(x = "Scenario"), function(x, transformer
 #' }
 #' 
 #' # Install helloworldSpatial package
-#' addPackage("helloworldSpatial")
+#' installPackage("helloworldSpatial")
 #' 
 #' # Set SsimLibrary name
 #' myLibraryName <- file.path(tempdir(),"testlib")

R/command.R

@@ -35,7 +35,7 @@ NULL
 #' @examples
 #' \dontrun{
 #' # Install "stsim" if not already installed
-#' addPackage("stsim")
+#' installPackage("stsim")
 #' 
 #' # Set the file path and name of the new SsimLibrary
 #' myLibraryName <- file.path(tempdir(),"testlib.ssim")

R/datasheet.R

@@ -90,7 +90,7 @@ NULL
 #' @examples 
 #' \dontrun{
 #' # Install helloworldSpatial package from package server
-#' addPackage("helloworldSpatial")
+#' installPackage("helloworldSpatial")
 #' 
 #' # Set the file path and name of the new SsimLibrary
 #' myLibraryName <- file.path(tempdir(),"testlib_datasheet")

R/datasheetRaster.R

@@ -60,7 +60,7 @@ NULL
 #' @examples
 #' \dontrun{
 #' # Install the helloworldSpatial package from the server
-#' addPackage("helloworldSpatial")
+#' installPackage("helloworldSpatial")
 #' 
 #' # Specify file path and name of new SsimLibrary
 #' myLibraryName <- file.path(tempdir(), "testlib_datasheetRaster")
@@ -112,7 +112,7 @@ NULL
 #'                  
 #' # Filter for only rasters that fit specific criteria
 #' # Load the ST-Sim spatial example library
-#' addPackage("stsim")
+#' installPackage("stsim")
 #' 
 #' # Set the file path and name of the new SsimLibrary
 #' myLibraryName <- file.path(tempdir(),"testlib_stsim_datasheet")

R/datasheetSpatRaster.R

@@ -55,7 +55,7 @@ NULL
 #' @examples
 #' \dontrun{
 #' # Install the helloworldSpatial package from the server
-#' addPackage("helloworldSpatial")
+#' installPackage("helloworldSpatial")
 #' 
 #' # Specify file path and name of new SsimLibrary
 #' myLibraryName <- file.path(tempdir(), "testlib_datasheetSpatRaster")
@@ -107,7 +107,7 @@ NULL
 #'                  
 #' # Filter for only rasters that fit specific criteria
 #' # Load the ST-Sim spatial example library
-#' addPackage("stsim")
+#' installPackage("stsim")
 #' 
 #' # Set the file path and name of the new SsimLibrary
 #' myLibraryName <- file.path(tempdir(),"testlib_stsim_datasheet")

R/deprecated.R

@@ -1,7 +1,7 @@
 #' Add module
 #'
 #' `r lifecycle::badge("deprecated")`
-#' Please use \code{\link{addPackage}} instead.
+#' Please use \code{\link{installPackage}} instead.
 #'
 #' @param filename character string or vector of these. The path to an .ssimpkg 
 #' file on disk, or a vector of filepaths.
@@ -11,24 +11,24 @@
 #' 
 #' @export
 addModule <- function(filename, session = NULL) {
-  lifecycle::deprecate_warn("1.2.11", "addModule()", "addPackage()")
-  addPackage(filename, session)
+  lifecycle::deprecate_warn("1.2.11", "addModule()", "installPackage()")
+  installPackage(filename, session)
 }
 
 #' Adds a package to SyncroSim
 #'
 #' `r lifecycle::badge("deprecated")`
-#' Please use \code{\link{addPackage}} instead.
+#' Please use \code{\link{installPackage}} instead.
 #'
 #' @param filename character string.  The path to a SyncroSim package file
 #' @param session \code{\link{Session}} object
 #' 
 #' @keywords internal
 #' 
 #' @export
-addPackageFile <- function(filename, session = NULL) {
-  lifecycle::deprecate_warn("1.2.11", "addPackageFile()", "addPackage()")
-  addPackage(filename, session)
+installPackageFile <- function(filename, session = NULL) {
+  lifecycle::deprecate_warn("1.2.11", "installPackageFile()", "installPackage()")
+  installPackage(filename, session)
 }
 
 #' Installed base packages
@@ -219,4 +219,4 @@ envStepSimulation <- function() {
 envEndSimulation <- function() {
   lifecycle::deprecate_warn("1.2.11", "envEndSimulation()", "progressBar()")
   progressBar(type = "end")
-}
+}

R/disableAddon.R

@@ -20,7 +20,7 @@ NULL
 #' @examples
 #' \donttest{
 #' # Install "stsim" SyncroSim package
-#' addPackage("stsim")
+#' installPackage("stsim")
 #' 
 #' # Specify file path and name of new SsimLibrary
 #' myLibraryName <- file.path(tempdir(), "testlib")

R/enableAddon.R

@@ -20,7 +20,7 @@ NULL
 #' @examples
 #' \donttest{
 #' # Install "stsim" SyncroSim package
-#' addPackage("stsim")
+#' installPackage("stsim")
 #' 
 #' # Specify file path and name of new SsimLibrary
 #' myLibraryName <- file.path(tempdir(), "testlib")

R/addPackage.R → R/installPackage.R

@@ -8,7 +8,7 @@ NULL
 #' This function installs a package to the SyncroSim \code{\link{Session}}.
 #' If only the package name is provided as input, the function queries the 
 #' SyncroSim package server for the specified package. If a file path is 
-#' provided as input, the function adds a package to SyncroSim from a local 
+#' provided as input, the function installs a package to SyncroSim from a local 
 #' package file (ends in ".ssimpkg"). The list of SyncroSim packages can be 
 #' found \href{https://syncrosim.com/packages/}{here}.
 #'
@@ -26,29 +26,29 @@ NULL
 #' # Create a new SyncroSim Session
 #' mySession <- session()
 #' 
-#' # Add package from the package server
-#' addPackage("stsim", session = mySession)
+#' # Install package from the package server
+#' installPackage("stsim", session = mySession)
 #' 
-#' # Add package using a local file path
-#' addPackage("c:/path/to/stsim.ssimpkg")
+#' # Install package using a local file path
+#' installPackage("c:/path/to/stsim.ssimpkg")
 #' }
 #' 
 #' @export
-setGeneric("addPackage", function(name, session = NULL) standardGeneric("addPackage"))
+setGeneric("installPackage", function(name, session = NULL) standardGeneric("installPackage"))
 
-#' @rdname addPackage
-setMethod("addPackage", signature(session = "character"), function(name, session) {
+#' @rdname installPackage
+setMethod("installPackage", signature(session = "character"), function(name, session) {
   return(SyncroSimNotFound(session))
 })
 
-#' @rdname addPackage
-setMethod("addPackage", signature(session = "missingOrNULL"), function(name, session) {
+#' @rdname installPackage
+setMethod("installPackage", signature(session = "missingOrNULL"), function(name, session) {
   session <- .session()
-  return(addPackage(name, session))
+  return(installPackage(name, session))
 })
 
-#' @rdname addPackage
-setMethod("addPackage", signature(session = "Session"), function(name, session) {
+#' @rdname installPackage
+setMethod("installPackage", signature(session = "Session"), function(name, session) {
   success <- FALSE
 
   if (is.null(name)) {

R/package.R

@@ -44,7 +44,7 @@ NULL
 #' package(myLibrary)
 #' 
 #' # Check the templates available for an installed package
-#' addPackage("helloworldSpatial")
+#' installPackage("helloworldSpatial")
 #' package(listTemplates = "helloworldSpatial")
 #' }
 #' 

R/parentId.R

@@ -18,7 +18,7 @@ NULL
 #' @examples 
 #' \donttest{
 #' # Install helloworldSpatial SyncroSim package
-#' addPackage("helloworldSpatial")
+#' installPackage("helloworldSpatial")
 #' 
 #' # Set the file path and name of the new SsimLibrary
 #' myLibraryName <- file.path(tempdir(),"testlib_parentId")

R/run.R

@@ -36,7 +36,7 @@ NULL
 #' @examples 
 #' \dontrun{
 #' # Install helloworldSpatial package
-#' addPackage("helloworldSpatial")
+#' installPackage("helloworldSpatial")
 #' 
 #' # Set the file path and name of the new SsimLibrary
 #' myLibraryName <- file.path(tempdir(),"testlib")

R/runLog.R

@@ -15,7 +15,7 @@ NULL
 #' @examples 
 #' \dontrun{
 #' # Install helloworldSpatial package
-#' addPackage("helloworldSpatial")
+#' installPackage("helloworldSpatial")
 #' 
 #' # Set the file path and name of the new SsimLibrary
 #' myLibraryName <- file.path(tempdir(),"testlib")

R/saveDatasheet.R

@@ -66,7 +66,7 @@ NULL
 #' @examples 
 #' \donttest{
 #' # Install helloworldSpatial package
-#' addPackage("helloworldSpatial")
+#' installPackage("helloworldSpatial")
 #' 
 #' # Set the file path and name of the new SsimLibrary
 #' myLibraryName <- file.path(tempdir(),"testlib_saveDatasheet")

R/sqlStatement.R

@@ -42,7 +42,7 @@ NULL
 #' 
 #' # The SQL statement can then be used in the datasheet function
 #' # Install helloworldSpatial package
-#' addPackage("helloworldSpatial")
+#' installPackage("helloworldSpatial")
 #' 
 #' # Set the file path and name of the new SsimLibrary
 #' myLibraryName <- file.path(tempdir(),"testlib_sqlStatement")

R/ssimLibrary.R

@@ -35,7 +35,7 @@ setMethod(
     packageOptions <- package(session, installed = "BASE")
 
     if (nrow(packageOptions) == 0) {
-      stop("No base packages are installed.  Use addPackage() to install a package.")
+      stop("No base packages are installed.  Use installPackage() to install a package.")
     }
 
     if (identical(basename(name), name)) {
@@ -154,7 +154,7 @@ setMethod(
     tt <- command(args, session)
 
     if (grepl("Could not find package", tt[[1]])) {
-      stop(paste(tt[[1]], "Use addPackage() to install this package."))
+      stop(paste(tt[[1]], "Use installPackage() to install this package."))
     }
 
     if (grepl("The library has unapplied updates", tt[[1]])) {
@@ -309,8 +309,8 @@ setMethod(".ssimLibrary", signature(name = "SsimObject"), function(name, package
 #' @examples
 #' \donttest{
 #' # Make sure packages are installed
-#' addPackage("stsim")
-#' addPackage("stsimsf")
+#' installPackage("stsim")
+#' installPackage("stsimsf")
 #' 
 #' # Create or open a SsimLibrary using the default Session
 #' myLibrary <- ssimLibrary(name = file.path(tempdir(), "mylib"))
@@ -330,7 +330,7 @@ setMethod(".ssimLibrary", signature(name = "SsimObject"), function(name, package
 #'                          addon = "stsimsf")
 #' 
 #' # Create SsimLibrary from template
-#' addPackage("helloworldSpatial")
+#' installPackage("helloworldSpatial")
 #' mySession <- session()
 #' myLibrary <- ssimLibrary(name = file.path(tempdir(), "mylib"), 
 #'                          session = mySession,