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(
  evidence_url = TRUE,
  evidence_media_url = TRUE,
  evidence_text = TRUE,
  label = TRUE,
  description = TRUE,
  alternative_label = FALSE,
  alternative_description = FALSE,
  evidence_relation = FALSE,
  subject_range = TRUE,
  subject_definition = TRUE,
  columns = NULL,
  context = NULL
)

Arguments

evidence_url

Include the evidence_url column.

evidence_media_url

Include the evidence_media_url column.

evidence_text

Include the evidence_text column.

label

Include the label column.

description

Include the description column.

alternative_label

Include the alternative_label column.

alternative_description

Include the alternative_description column.

evidence_relation

Include the evidence_relation and evidence_relation_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_number 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.

Examples

create_candidate_template()
#> [1] row_number         evidence_url       evidence_media_url evidence_text     
#> [5] label              description        subject            subject_range     
#> [9] subject_definition
#> <0 rows> (or 0-length row.names)

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