Skip to contents

Create a batch annotation session

Source: R/class-session.R
at_session.Rd

Create a batch annotation session

Usage

at_session(
  paths,
  labels = character(),
  layers = NULL,
  out_dir = .session_out_dir(),
  autosave = TRUE,
  ...,
  call = rlang::caller_env()
)

Arguments

paths

Character vector of image file paths forming the queue.

labels

Character vector of the global label vocabulary. Duplicates are dropped.

layers

An annot_layer, a list of them, or NULL. Applied as a template to every image visited.

out_dir

Directory for autosave and exports. Defaults to a new, unique directory under tempdir(), which R deletes when the process ends: pass a persistent directory to keep autosaved work. Separate sessions never share a default directory. A relative path is resolved against the working directory when the session is created.

autosave

Logical; whether to autosave on annotation commits. Default TRUE.

...

Additional named session metadata.

call

The calling environment, for error reporting.

Value

An annot_session with a manifest over paths, all statuses "pending", the cursor at the first image, and projects not yet materialised.

See also

at_next(), at_current(), at_resume()

Other sessions: at_current(), at_example_session(), at_goto(), at_manifest(), at_next(), at_prev(), at_resume(), at_session_status(), at_set_status()

Examples

# Build a session over the bundled example image copied several times:
# sess <- at_example_session(3)