upload_job: Upload a CCS Annotator codingjob to a server

View source: R/job_management.r

upload_jobR Documentation

Upload a CCS Annotator codingjob to a server

Description

Upload a CCS Annotator codingjob to a server

Usage

upload_job(
  title,
  units,
  codebook = NULL,
  annotations = NULL,
  rules = rules_fixedset(),
  jobsets = NULL,
  debrief = NULL,
  pre = NULL,
  post = NULL
)

Arguments

title

A character string, for the title of the codingjob

units

A codingjobUnits object, as created with create_units

codebook

A codebook object, as created with create_codebook. Can only be missing if jobsets with specific codebooks are provided (see jobsets argument)

annotations

Optionally, create the job with imported annotations. Should be a data.frame like returned by gimme_annotations, with the columns: id, field, variable, value, offset and length. The "id" column should match the id column in the units (based on the id argument in create_units). "field" should be a text field in units. "variable" and "value" should match actual variables (or questions) and codes in the codebook. "offset" and "length" are the character position offset and the length of the span annotation.

rules

A rules object, as created with one of the rules_* functions (e.g., rules_crowdcoding, rules_fixedset). If left empty, the 'crowdcoding' ruleset will be used.

jobsets

A list of jobsets, as created with jobset

debrief

At debriefing when a job is finished, such as a message and link. Create with debrief

pre

A special unit or list of special units to show before the codingjob.

post

Like pre, but for after the codingjob.

Value

The id of the new codingjob on the server


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