Skip to contents

Project class get and set methods

Source: R/project.R
Project-accessors.Rd

Get and set methods for the Project S4 class.

Usage

projectName(x)

# S4 method for Project
projectName(x)

projectName(x) <- value

# S4 method for Project
projectName(x) <- value

path(x)

# S4 method for Project
path(x)

path(x) <- value

# S4 method for Project
path(x) <- value

renv(x)

# S4 method for Project
renv(x)

renv(x) <- value

# S4 method for Project
renv(x) <- value

docker(x)

# S4 method for Project
docker(x)

docker(x) <- value

# S4 method for Project
docker(x) <- value

github(x)

# S4 method for Project
github(x)

github(x) <- value

# S4 method for Project
github(x) <- value

private(x)

# S4 method for Project
private(x)

private(x) <- value

# S4 method for Project
private(x) <- value

githubActions(x)

# S4 method for Project
githubActions(x)

githubActions(x) <- value

# S4 method for Project
githubActions(x) <- value

parallelPlan(x)

# S4 method for Project
parallelPlan(x)

parallelPlan(x) <- value

# S4 method for Project
parallelPlan(x) <- value

force(x)

# S4 method for Project
force(x)

force(x) <- value

# S4 method for Project
force(x) <- value

Arguments

x

S4 object of class Project

value

value to set

Examples

workflow_project <- defineProject('A metabolomics project')

## Return the project name
projectName(workflow_project)
#> [1] "A metabolomics project"

## Set the project name
projectName(workflow_project) <- 'A new name'

## Return the project directory path
path(workflow_project)
#> [1] "."

## Set the project directory path
path(workflow_project) <- './a_directory'

## Return the project renv option
renv(workflow_project)
#> [1] TRUE

## Set the project renv option
renv(workflow_project) <- FALSE

## Return the project docker option
docker(workflow_project)
#> [1] TRUE

## Set the project docker option
docker(workflow_project) <- FALSE

## Return the project github option
github(workflow_project)
#> [1] FALSE

## Set the project github option
github(workflow_project) <- TRUE

## Return the project private option
private(workflow_project)
#> [1] FALSE

## Set the project private option
private(workflow_project) <- TRUE

## Return the project github actions option
githubActions(workflow_project)
#> [1] FALSE

## Set the project github actions option
githubActions(workflow_project) <- TRUE

## Return the expression project parallel plan
parallelPlan(workflow_project)
#> jfmisc::suitableParallelPlan()

## Set the expression for the project parallel plan
parallelPlan(workflow_project) <- rlang::expr(future::plan(strategy = 'multisession',workers = 2))

## Return the project force option
force(workflow_project)
#> [1] FALSE

## Set the project force option
force(workflow_project) <- TRUE