export_project {projects}

Compress a project folder

Description

Creates a compressed file out of a user-specified project folder for sharing.

Usage

export_project(project, zipfile, include_hidden = FALSE, exclude = NULL)

Arguments

project

Project id or unambiguous substring of the project name from the projects() table.

zipfile

Desired file path of the resulting compressed folder file, including the file's desired name and file extension. See the zipfile argument for the zip::zipr() function.

include_hidden

Logical indicating whether or not to include hidden folders and files (e.g., those with names that begin with a period). Defaults to FALSE.

exclude

Character vector of exact names of first-level subdirectories of the project folder to exclude from the resulting compressed folder file.

Details

Currently, this function uses zip::zipr().

Value

The name of the created zip file, invisibly.