Skip to contents

Start a Project

Source: R/project.R
project_start.Rd

Activates a project to allow workers to begin consuming tasks. Workers will only process tasks from started projects.

Usage

project_start(project, con = NULL)

Arguments

project

Character string specifying the project name.

con

An optional database connection. If NULL, a new connection is created and closed automatically.

Value

Invisibly returns NULL. Called for side effects (updating project status).

Details

Starting a project sets its status field to TRUE in the database. Workers check this status before requesting new tasks. If a project is stopped (status = FALSE), workers will terminate instead of processing tasks.

You must start a project before deploying workers with worker or worker_slurm.

See also

project_stop, project_add, worker, worker_slurm

Examples

if (FALSE) { # \dontrun{
# Not run:
# Start project to enable workers
project_start("simulation_study")

# Deploy workers after starting
worker_slurm("simulation_study", "hpc", fun = my_function)
} # }