Skip to content

Commit

Permalink
Rename removePackage to uninstallPackage
Browse files Browse the repository at this point in the history
  • Loading branch information
katieb1 committed Nov 30, 2023
1 parent c6acb2e commit b364dc7
Show file tree
Hide file tree
Showing 17 changed files with 80 additions and 80 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,14 @@ Collate:
'printCmd.R'
'published.R'
'readOnly.R'
'removePackage.R'
'rsyncrosim.R'
'run.R'
'runLog.R'
'saveDatasheet.R'
'silent.R'
'ssimEnvironment.R'
'ssimUpdate.R'
'uninstallPackage.R'
'updatePackage.R'
'useConda.R'
'version.R'
Expand Down
2 changes: 1 addition & 1 deletion NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ export(project)
export(projectId)
export(published)
export(readOnly)
export(removePackage)
export(run)
export(runLog)
export(runtimeInputFolder)
Expand All @@ -70,6 +69,7 @@ export(ssimEnvironment)
export(ssimLibrary)
export(ssimUpdate)
export(tempfilepath)
export(uninstallPackage)
export(updatePackage)
export(updateRunLog)
export(useConda)
Expand Down
28 changes: 14 additions & 14 deletions R/removePackage.R → R/uninstallPackage.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
#' @include AAAClassDefinitions.R
NULL

#' Removes package from SyncroSim installation
#' Removes a package from SyncroSim installation
#'
#' @param name character. The name of the package to remove
#' @param name character. The name of the package to uninstall
#' @param session \code{\link{Session}} object. If \code{NULL} (default),
#' \code{session()} will be used
#' @param force logical. If \code{TRUE}, remove without requiring confirmation from
#' the user. Default is \code{FALSE}
#' @param force logical. If \code{TRUE}, uninstall without requiring
#' confirmation from the user. Default is \code{FALSE}
#'
#' @return
#' Invisibly returns \code{TRUE} upon success (i.e.successful
Expand All @@ -20,26 +20,26 @@ NULL
#' # Set SyncroSim Session
#' mySession <- session()
#'
#' # Remove package from SyncroSim Session
#' removePackage("stsim", mySession, force = FALSE)
#' # Uninstalls package from SyncroSim Session
#' uninstallPackage("stsim", mySession, force = FALSE)
#' }
#'
#' @export
setGeneric("removePackage", function(name, session = NULL, force = FALSE) standardGeneric("removePackage"))
setGeneric("uninstallPackage", function(name, session = NULL, force = FALSE) standardGeneric("uninstallPackage"))

#' @rdname removePackage
setMethod("removePackage", signature(session = "character"), function(name, session, force) {
#' @rdname uninstallPackage
setMethod("uninstallPackage", signature(session = "character"), function(name, session, force) {
return(SyncroSimNotFound(session))
})

#' @rdname removePackage
setMethod("removePackage", signature(session = "missingOrNULL"), function(name, session, force) {
#' @rdname uninstallPackage
setMethod("uninstallPackage", signature(session = "missingOrNULL"), function(name, session, force) {
session <- .session(session)
return(removePackage(name, session, force))
return(uninstallPackage(name, session, force))
})

#' @rdname removePackage
setMethod("removePackage", signature(session = "Session"), function(name, session, force) {
#' @rdname uninstallPackage
setMethod("uninstallPackage", signature(session = "Session"), function(name, session, force) {
installed <- package(session)
success <- FALSE

Expand Down
2 changes: 1 addition & 1 deletion docs/articles/a01_rsyncrosim_vignette_basic.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/articles/rsyncrosim_vignette_basic.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/reference/deleteModule.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/reference/deletePackage.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 7 additions & 7 deletions docs/reference/removePackage.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@
<loc>https://syncrosim.github.io/rsyncrosim/reference/readOnly.html</loc>
</url>
<url>
<loc>https://syncrosim.github.io/rsyncrosim/reference/removePackage.html</loc>
<loc>https://syncrosim.github.io/rsyncrosim/reference/uninstallPackage.html</loc>
</url>
<url>
<loc>https://syncrosim.github.io/rsyncrosim/reference/rsyncrosim.html</loc>
Expand Down
Loading

0 comments on commit b364dc7

Please sign in to comment.