sftp_listdirs: List folders in an SFTP directory

Description Usage Arguments Value See Also Examples

View source: R/sftp_functions.R

Description

Convenience function wrapping sftp_list with type hard set to "dir". Questions? https://github.com/stenevang/sftp

Usage

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

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 RCurl::curlPerform. Default is FALSE.

recurse

Logical. Recurse directories? 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_listdirs. Optional. Default is an empty list.

Value

A dataframe

See Also

sftp_listfiles, sftp_list, sftp

Examples

1
2
3
4
5
6
7
# minimal - rely on defaults
files <- sftp_listdirs()

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

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