Skip to contents

Deletes a SyncroSim library. Note this is irreversable.

Usage

deleteLibrary(
  ssimLibrary,
  force = FALSE,
  removeBackup = FALSE,
  removePublish = FALSE,
  removeCustom = FALSE,
  session = NULL
)

Arguments

ssimLibrary

SsimLibrary or path to a library

force

Logical. If FALSE (default) prompt to confirm that the library should be deleted. This is irreversable.

removeBackup

logical. If TRUE, will remove the backup folder when deleting a library. Default is FALSE.

removePublish

logical. If TRUE, will remove the publish folder when deleting a library. Default is FALSE.

removeCustom

logical. If TRUE and custom folders have been configured for a library, then will remove the custom publish and/or backup folders when deleting a library. Note that the removePublish and removeBackup arguments must also be set to TRUE to remove the respective custom folders. Default is FALSE.

session

Session

Value

"saved" or failure message.

#' @examples