sftp_makedir: Create a new directory in an SFTP account

Description Usage Arguments Value See Also Examples

View source: R/sftp_functions.R

Description

Create one or several directories (subdirectories) in an SFTP account. The function uses connection credentials from a list object created by calling sftp_connect. sftp_makedir internally calls RCurl::curlPerform Questions? https://github.com/stenevang/sftp

Usage

1
2
3
4
5
6
7
sftp_makedir(
  foldername,
  sftp_connection = sftp_con,
  verbose = TRUE,
  curlPerformVerbose = FALSE,
  curl_options = list()
)

Arguments

foldername

A character vector of length 1 or more, containing the names of folders you want to create. The folder(s) will be created below the folder where you are currently standing according to the sftp connection list object you are using (default 'stfp_con'). A folder with subfolder and subsubfolder etc can be created in one single operation by supplying a path, like "folder1/folder2/folder3".

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.

curl_options

A list of named values with names as listed by RCurl::listCurlOptions. The values are handed to the .opts parameter of the RCurl function called by sftp_makedir. Optional. Default is an empty list.

Value

The function returns the number of new folders created.

See Also

sftp_removedir, sftp_rename, sftp_changedir, sftp

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# minimal - create one folder, rely on defaults
sftp_makedir("great_folder_name")

# explicit - create a multi-level path
sftp_makedir(foldername = "level1/folder2/directory3",
             sftp_connection = sftp_con,
             verbose = TRUE,
             curlPerformVerbose = FALSE)

 # create new folders as specified in a vector with names
 sftp_makedir(newfolders$names)

stenevang/sftp documentation built on Feb. 8, 2022, 6:40 p.m.