Description
A calculated field can be used to define a formula that presents calculation results in the form.
Usage
calculatedFieldSchema(
label,
description = NULL,
formula,
code = NULL,
id = cuid(),
hideFromEntry = FALSE,
hideInTable = FALSE,
relevanceRule = "",
reviewerOnly = FALSE
)
Arguments
| Argument | Description |
|---|---|
label |
The label of the form field |
description |
The description of the form field |
formula |
A character string with the calculation formula |
code |
The code name of the form field |
id |
The id of the form Field; default is to generate a new cuid |
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 "" |
reviewerOnly |
Whether the form field is for reviewers only; default is FALSE |
Details
A calculated field cannot be a key field.
See also
Other field schemas: attachmentFieldSchema , barcodeFieldSchema , dateFieldSchema , formFieldSchema , geopointFieldSchema , monthFieldSchema , multilineFieldSchema , multipleSelectFieldSchema , quantityFieldSchema , referenceFieldSchema , sectionFieldSchema , serialNumberFieldSchema , singleSelectFieldSchema , subformFieldSchema , userFieldSchema , weekFieldSchema