Establishing the connection

To interact with the WebDAV server, you have to create a connection via wd_connect by supplying the URL, username and password.

In an interactive R session, you may omit the password when calling wd_connect. Then R will ask you to type the password.

# no password given, R will ask.
r <- wd_connect(url = "https://cloud.example.com/remote.php/webdav/",
                username = "myusername")

When using WebDAV in a script, you have to pass the password to wd_connect. It is not good practice, to write the password literally in your script

# Don"t do this! You would reveal your super secret password to others when
# sharing your script.
r <- wd_connect(url = "https://cloud.example.com/remote.php/webdav/",
                username = "myusername",
                password = "12345")

Better use your system”s credential store (i. e. the password will be stored encrypted in your user account). You may use the package keyring to access the system”s credential store.

You once have to set a key / password combination on your computer by calling:

keyring::key_set("mycloud", "myusername")

You will be asked for the password and then the credentials are stored on your system.

In your scripts you can then use keyring::get_key("mycloud","myusername") to pass the stored password to wd_connect:

r <- wd_connect(url = "https://cloud.example.com/remote.php/webdav/",
                username = "myusername",
                password = keyring::get_key("mycloud", "myusername"))

Downloading and uploading data

To download a file, you have to give the path of the filename on the server, as well as the path to the location where you want to store the file on your computer.

wd_download(r, "data/data.csv", "localdata/data_new.csv")

Instead of giving the full path of the target file, you can use only the directory name. Then the file will be stored in that folder with the same name as it has on the server.

wd_download(r, "data/data.csv", "localdata")

You can download full directories. All the data within the directory, including subdirectories will be downloaded.

wd_download(r, "data", "localdata")

For uploading data from your computer, you have to use wd_upload in a similar way as wd_download:

wd_upload(r, "localdata/data.csv", "data/data_new.csv")
wd_upload(r, "localdata/data.csv", "data")
wd_upload(r, "localdata", "data")

Notice:

• If you upload / download files into a directory, the target directory has to exist already.
• If you upload / download a directory, then the target directory will be created, if it does not exist. However, the parent directory have to exist already

Copy, move, delete files on the server

You can copy, move, delete files or directory on the server and create new directories.

By default existing files will be overwritten when using copy and move operation, unless you specify the parameter overwrite=FALSE. Notice: Some WebDAV servers may behave differently and won’t overwrite files. In these case you have to delete files first.

wd_copy(r, "actual.csv", "backup.csv")
wd_move(r, "backup.csv", "backup-2024-02-27.csv")
wd_move(r, "backup.csv", "backup-2024-02-27.csv", overwrite = FALSE)
wd_delete(r, "obsolete.csv")

You can create new directories.

wd_mkdir(r, "data/soil/new")

Notice that parent directories have to exist. If not, you have to create them first

wd_mkdir(r, "data/soil")
wd_mkdir(r, "data/soil/new")

Get informations about files and directories

You can get the list of files and subfolders as a character vector by using wd_dir. Using the parameter full_names = TRUE will give you the files with relative paths.

To get more information about files, you can use the option as_df = TRUE. You will then get a data.frame with additional columns like size, last modification date and contenttype.

wd_dir(r) # get content of main folder
wd_dir(r, "example")
wd_dir(r, "example", full_names = TRUE)
wd_dir(r, "example", as_df = TRUE)

Don’t put passwords in your code

You should avoid putting passwords in your code. See the example in the sections above how to use system credential store.

Use application passwords instead of account passwords

Some cloud services offer you the possibility to create additional application passwords. If you use an application password with rdav, and the password gets somehow disclosed, you can just delete the application password and create a new one. You don’t have to change then your account’s password.

Use password protected public shares instead direct account

Instead accessing the full account, you may create a subfolder and share it via a public link, adding a password. You can give the share full read / write and edit rights, so you can manage the content of the folder as you were logged in with your main account.

If someone gets access to your share, only the data in this folder can then be manipulated.

When sharing data, use different shares for writing and reading

If you want to share data with other people, create public shares. Don’t give them your account credentials.

You may create separated shares for reading and writing data if appropriate.

• make a folder your_upload and create a write-only share to receive data from other users
• make a folder your_download and create a read-only share to make data available to other users

Then you can check the uploaded files and move them to the download folder, or process uploaded files and save results you want to share to the download folder.

This will prevent that someone who gained access to the share to distribute illegal content. Even if illegal content might then get uploaded, no one else can download it.