synchronize_directory: Function to synchronize a local and remote directory with...

View source: R/synchronize_directory.R

synchronize_directoryR Documentation

Function to synchronize a local and remote directory with rsync.

Description

Please note, synchronize_directory will delete files in the remote directory if not present in the local directory by default.

Usage

synchronize_directory(
  directory_local,
  directory_remote,
  calculate_size = TRUE,
  dry_run = TRUE,
  delete = TRUE,
  verbose = TRUE
)

Arguments

directory_local

Local directory to synchronize to remote directory.

directory_remote

Remote directory to synchronize from local directory.

calculate_size

Should the function calculate and include directory size in the return?

dry_run

Should rsync be run in dry run mode to simulate, but not conduct the file synchronization. Good for testing.

delete

Should files be deleted? synchronize_directory will delete files in the remote directory if not present in the local directory by default.

verbose

Should the function give messages?

Value

Tibble with programme timing information.

Author(s)

Stuart K. Grange


skgrange/systemr documentation built on April 18, 2024, 2:23 a.m.