referenceFieldSchema: Create a Reference field schema

View source: R/formField.R

referenceFieldSchemaR Documentation

Create a Reference field schema

Description

A reference field can be used to make reference to a record in another form.

Usage

referenceFieldSchema(
  label,
  description = NULL,
  referencedFormId,
  code = NULL,
  id = cuid(),
  key = FALSE,
  required = key,
  hideFromEntry = FALSE,
  hideInTable = FALSE,
  relevanceRule = "",
  validationRule = "",
  reviewerOnly = FALSE
)

Arguments

label

The label of the form field

description

The description of the form field

referencedFormId

The id of the referenced form

code

The code name of the form field

id

The id of the form Field; default is to generate a new cuid

key

Whether the form field is a key field; default is FALSE

required

Whether the form field is required; default is FALSE

hideFromEntry

Whether the form field is hidden during data entry; default is FALSE

hideInTable

Whether the form field is hidden during data display; default is FALSE

relevanceRule

Relevance rules for the form field given as a single character string; default is ""

validationRule

Validation rules for the form field given as a single character string; default is ""

reviewerOnly

Whether the form field is for reviewers only; default is FALSE

See Also

Other field schemas: attachmentFieldSchema(), barcodeFieldSchema(), calculatedFieldSchema(), dateFieldSchema(), formFieldSchema(), geopointFieldSchema(), monthFieldSchema(), multilineFieldSchema(), multipleSelectFieldSchema(), quantityFieldSchema(), sectionFieldSchema(), serialNumberFieldSchema(), singleSelectFieldSchema(), subformFieldSchema(), userFieldSchema(), weekFieldSchema()


bedatadriven/activityinfo-R documentation built on Dec. 21, 2024, 8:23 a.m.