check_files_to_osf: Check which files will be uploaded to OSF

View source: R/check_files_to_osf.R

check_files_to_osfR Documentation

Check which files will be uploaded to OSF

Description

Verify that the file/folder names and pattern strings specificed in upload_to_osf(skip_files = c()) argument will only upload the files you want to upload.

Usage

check_files_to_osf(dir = ".", skip_files = c(), recursive = TRUE)

Arguments

dir

A file path to a first-level directory in your local project folder. e.g., "data". Do not specifiy second-level directories e.g., "data/raw".

To upload files from the root project folder, specify dir = "." or leave out argument.

skip_files

An array of file/folder names and pattern strings to not include in the upload to OSF. e.g., you might have a folder of "old" scripts or data files that you do not want uploaded.

recursive

Search files recursively? Set to FALSE if you only want the files in a first-level directory and not any further sub-directories. e.g., "data" or ".".


dr-JT/workflow documentation built on March 19, 2024, 7:51 p.m.