sftp_listdirs: List folders in an SFTP directory

View source: R/sftp.R

sftp_listdirsR Documentation

List folders in an SFTP directory

Description

Convenience function wrapping sftp_list with type hard set to "dir".

Usage

sftp_listdirs(
  sftp_connection = get("sftp_con"),
  verbose = TRUE,
  curlPerformVerbose = FALSE,
  recurse = FALSE
)

Arguments

sftp_connection

A list created by calling sftp_connect Default value is sftp_con.

verbose

Logical. Turn on messages to console. Default is TRUE.

curlPerformVerbose

Logical. Turn on messages to console from curlPerform. Default is FALSE.

recurse

Logical. Recurse directories? Default is FALSE.

Value

A tibble

Author(s)

Theodor Stenevang Klemming

See Also

sftp_listfiles, sftp_list

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

Examples


## Not run: 
# minimal - rely on defaults
files <- sftp_listdirs()

# explicit
files <- sftp_listdirs(sftp_connection = sftp_con,
                       verbose = TRUE,
                       curlPerformVerbose = FALSE)

## End(Not run)


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