gimme_annotations: Get annotation for a given job DB

View source: R/gimme_annotations.r

gimme_annotationsR Documentation

Get annotation for a given job DB

Description

Get annotation for a given job DB

Usage

gimme_annotations(db_file = NULL, only_done = FALSE)

Arguments

db_file

If NULL (default) looks whether an an annotation server (see start_annotator) ran (or is running) in the current session. If so, it retrieves the annotations from this server

only_done

If TRUE (default) only retrieve annotations with the "DONE" status. If FALSE, also retrieve annotations with the "IN_PROGRESS" status

Value

A tibble with annotations. The id column matches with the units (as specified in the id argument in create_units)

Examples

## Not run: 
# get annotation for most recent server run (or still running) in current session
gimme_annotations()

# from a job database, as returned by create_job_db (or by start_annotator)
job_db <- "path/to/job.db"
gimme_annotations(job_db)

## End(Not run)

ccs-amsterdam/ccsAnnotator documentation built on March 19, 2024, 2:14 a.m.