sftp_upload: Upload files to an SFTP account

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

Upload files to an SFTP account

Description

This function is used for uploading files to an SFTP account. The function uses connection credentials from a list object created by calling sftp_connect. The files will be uploaded to the SFTP account folder where you are currently "standing" as specified in the connection list object.

Usage

sftp_upload(
  file,
  fromfolder = getwd(),
  sftp_connection = get("sftp_con"),
  log_file = NA,
  verbose = TRUE
)

Arguments

file	A character vector of file names. If the wildcard "*" is used, then all files in fromfolder will be uploaded. NOTE! Names of folders (directories) cannot be part of file. To create folders on the SFTP server, please see sftp_makedir.
fromfolder	A string containing a valid path - relative or absolute - to the folder where the files in file can be found. Default is the working directory.
sftp_connection	A list object created with link{sftp_connect}. Default is "sftp_con".
log_file	Valid path to a text file (.txt, .csv, .log etc) including filename and file extension.
verbose	Logical. Turn on messages to console. Default is TRUE.

Value

The function returns the number of files uploaded, following successful upload.

Author(s)

Theodor Stenevang Klemming

See Also

sftp_download, sftp_delete, sftp_rename

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

Examples

## Not run: 
# minimal - upload all files in the current working directory
sftp_upload("*")

# take a vector of file names from a dataframe
sftp_upload(file = files$name, fromfolder = "my/relative/path/")

# take one specific file name from a vector from a dataframe
sftp_upload(file = files$name[1], fromfolder = getwd())

## End(Not run)

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