Skip to contents

Renders a Betwixt candidate dataset as a standalone HTML review.

Source: R/betwixt_render.R
betwixt_render.Rd

The generated review preserves the original candidate values alongside editable review values. It also records the original HTML filename and its creation time as artefact provenance. Timestamps are represented as ISO 8601 UTC values at one-second precision.

A review belongs to a project, has a filename stem, and has a non-negative sequence number. Sequence 0 represents the initial candidate review. Subsequent review states may use sequence 1, 2, and so on. Saving a draft or finalising a review does not itself change the sequence. The project identifier records the stable identity of the review project. The filename stem is used independently to construct saved review filenames.

Usage

betwixt_render(
  candidate,
  cols = NULL,
  subheadings = NULL,
  title = "Betwixt Review",
  description = "Please review the following claims.",
  row_comment = FALSE,
  review_comment = FALSE,
  filename_stem = "betwixt-review",
  project_id = "",
  sequence = 0L,
  path = NULL
)

Arguments

candidate

A Betwixt candidate dataset.

cols

An optional named character vector containing presentation labels for candidate and context columns.

subheadings

An optional named character vector containing presentation subheadings for candidate columns.

title

Character string used as the review title.

description

Character string containing review instructions.

row_comment

Logical. If TRUE, adds an optional reviewer comment field to each review row. Defaults to FALSE.

review_comment

Logical. If TRUE, adds an optional comment field for the review as a whole. Defaults to FALSE.

filename_stem

Character string used as the base name for saved review files. Review sequences greater than 0 append the sequence number.

project_id

Character string identifying the review project.

sequence

A single non-negative integer identifying the review sequence. The initial candidate review has sequence 0.

path

Optional directory where the standalone review HTML is written. If NULL, the rendered HTML is returned without writing a file.

Value

Invisibly returns the rendered HTML when path is supplied; otherwise returns the HTML as a character string.