defineProject: Define a project directory

In jasenfinch/metaboWorkflows: Workflow Project Templates for Metabolomics Analyses

Define a project directory

Description

Define the project directory for a workflow

Usage

defineProject(
  project_name,
  path = ".",
  renv = TRUE,
  docker = TRUE,
  github = FALSE,
  private = FALSE,
  github_actions = FALSE,
  parallel_plan = jfmisc::suitableParallelPlan(),
  force = FALSE
)

Arguments

project_name	project name/title
path	target file path for project directory
renv	add infrastructure for reproducible R package environment management from the renv package
docker	TRUE/FALSE. Create project infrastructure for building a docker container to compile the project.
github	TRUE/FALSE. Create a GitHub repository?
private	TRUE/FALSE. Should the GitHub repository be private? Evaluated only if argument github is TRUE.
github_actions	TRUE/FALSE. Add Github actions infrastructure? Evaluated only if argument github is TRUE.
parallel_plan	An expression denoting the future parallel plan to use in the project template. See future::plan() for more information on future parallel plans.
force	force project creation if project directory already exists

Value

An S4 object of class Project.

Examples

workflow_project <- defineProject('A metabolomics project')

workflow_project

jasenfinch/metaboWorkflows documentation built on May 24, 2023, 8:23 a.m.