sftp_removedir: Remove a new directory in an SFTP account

In jesse-smith/coviData: COVID-19 Data Munging Tools for the Shelby County Health Department

Remove a new directory in an SFTP account

Description

Remove one or several directories (subdirectories) in an SFTP account. The function uses connection credentials from a list object created by calling sftp_connect.

Usage

sftp_removedir(
  foldername,
  sftp_connection = get("sftp_con"),
  verbose = TRUE,
  curlPerformVerbose = FALSE
)

Arguments

foldername	A character vector of length 1 or more, containing the names of folders you want to remove. The folder(s) will be looked for below the folder where you are currently standing according to the sftp connection list object you are using (default "stfp_con"). A subfolder (or a sub-subfolder, etc.) can be removed in one single operation by supplying a path, like "folder1/folder2/folder3". That will remove the last folder in the path, in this case "folder3". NOTE! Non-empty directories cannot be removed.
sftp_connection	A list object created by calling sftp_connect. Default is sftp_con.
verbose	Logical. Turn on messages to console. Default is TRUE
curlPerformVerbose	Logical. Turn on messages to console form curlPerform. Default is FALSE.

Value

The function returns the number folders deleted.

Author(s)

Theodor Stenevang Klemming

See Also

sftp_makedir, sftp_rename, sftp_changedir

Other sftp: sftp_changedir(), sftp_connect(), sftp_delete(), sftp_download(), sftp_listdirs(), sftp_listfiles(), sftp_list(), sftp_makedir(), sftp_rename(), sftp_upload()

Examples

## Not run: 
# minimal - remove one folder, rely on defaults
sftp_removedir("this_folder_is_bad")

# explicit - remove a directory at the end of a multi-level path
sftp_removedir(foldername = "level1/folder2/directory3",
             sftp_connection = sftp_con,
             verbose = TRUE,
             curlPerformVerbose = FALSE)

# remove several folders as specified in a vector of names
sftp_removedir(removefolders$names)

## End(Not run)

jesse-smith/coviData documentation built on Jan. 14, 2023, 11:08 a.m.