Skip to contents

Create an empty Betwixt candidate template

Source: R/create_candidate_template.R
create_candidate_template.Rd

Creates an empty candidate dataset template for preparing a Betwixt review. Standard descriptive and evidence columns can be included or omitted. Reviewable candidate columns are supplied through columns, while display-only contextual columns are supplied through context.

Usage

create_candidate_template(
  input_url = TRUE,
  input_media_url = TRUE,
  input_label = TRUE,
  input_description = TRUE,
  label = TRUE,
  description = TRUE,
  alternative_label = FALSE,
  alternative_description = FALSE,
  input_predicate = FALSE,
  subject_range = TRUE,
  subject_definition = TRUE,
  columns = NULL,
  context = NULL
)

Arguments

input_url

Include the input_url column.

input_media_url

Include the input_media_url column.

input_label

Include input_label column for an optional character vector containing short human-readable labels identifying the inputs.

input_description

Include the input_description column for optionally adding the human-readable descriptions of the inputs.

label

Include the label column for the optional human-readable labels for the subjects presented for review.

description

Include the description column for the optional description of the subjects presented for review.

alternative_label

Include the alternative_label column for the optional, alternative human-readable descriptions of the subjects presented for review, for example as a translation, a more detailed description, or a description intended for a different user group.

alternative_description

Include the alternative_description column.

input_predicate

Include the input_predicate and input_predicate_range columns.

subject_range

Include the subject_range column.

subject_definition

Include the subject_definition column.

columns

Optional character vector naming additional reviewable candidate columns. Each name creates a candidate column together with its _range and _definition columns.

context

Optional character vector naming display-only contextual columns.

Value

An empty tibble containing row_id and subject, together with the requested evidence, descriptive, candidate, and contextual columns.

Details

Candidate datasets can be created in a spreadsheet application after initialising a conforming header with create_candidate_template(). Re-imported datasets can be checked with validate_candidate_dataset() before rendering.

See also

create_candidate_dataset()

Examples

create_candidate_template()
#>  [1] row_id             input_url          input_media_url    input_label       
#>  [5] input_description  label              description        subject           
#>  [9] subject_range      subject_definition
#> <0 rows> (or 0-length row.names)

create_candidate_template(
  columns = c("instance_of", "heritage_of"),
  context = "held_by"
)
#>  [1] row_id                 input_url              input_media_url       
#>  [4] input_label            input_description      label                 
#>  [7] description            subject                subject_range         
#> [10] subject_definition     instance_of            instance_of_range     
#> [13] instance_of_definition heritage_of            heritage_of_range     
#> [16] heritage_of_definition held_by               
#> <0 rows> (or 0-length row.names)