schema_set_desc

Set or remove a schema node description

Provides a compact schema domain-specific language for inferring,
editing, and validating R data structures with 'checkmate' checks.
Schemas can be serialized to and restored from JSON for storage and
review. A generated standalone bundle supports vendoring the schema
tools into other R packages.

Hongyuan Jia

schemate

Schema Inference, Editing, and Validation with 'checkmate'

schema_set_desc function

<dl><dt>x</dt>
<dd>A <code>SchemaDoc</code>.</dd>
<dt>path</dt>
<dd>Path to the target schema node. Use <code>$</code> for the root node. Bare
field segments such as <code>$id</code> implicitly traverse container <code>fields</code>. Use
<code>$fields$id</code> to write the explicit field path. Backtick-quote field names
that contain path operators, for example <code>$`a$b` </code>.</dd>
<dt>description</dt>
<dd>Optional description string. Use <code>NULL</code> to remove the
description.</dd></dl>

Arguments

Set or remove a schema node description — schema_set_desc

<dl>

<dt>x</dt>
<dd>A <code>SchemaDoc</code>.</dd>


<dt>path</dt>
<dd>Path to the target schema node. Use <code>$</code> for the root node. Bare
field segments such as <code>$id</code> implicitly traverse container <code>fields</code>. Use
<code>$fields$id</code> to write the explicit field path. Backtick-quote field names
that contain path operators, for example <code>$`a$b` </code>.</dd>


<dt>description</dt>
<dd>Optional description string. Use <code>NULL</code> to remove the
description.</dd>

</dl>

schema_set_desc: Set or remove a schema node description

Description

Usage

Value

Arguments

Examples