cff_schema: Schema utils

In cffr: Generate Citation File Format ('cff') Metadata for R Packages

Schema utils

Description

Helper functions with the valid values of different fields, according to the Citation File Format schema version 1.2.0.

• cff_schema_keys() provides the valid high-level keys of the Citation File Format.

• cff_schema_keys_license() provides the valid SPDX license identifier(s) to be used on the CITATION.cff file.

• cff_schema_definitions_person() and cff_schema_definitions_entity() returns the valid fields to be included when defining a person or entity.

• cff_schema_definitions_refs() provides the valid keys to be used on the preferred-citation and references keys.

Usage

cff_schema_keys(sorted = FALSE)

cff_schema_keys_license()

cff_schema_definitions_person()

cff_schema_definitions_entity()

cff_schema_definitions_refs()

Arguments

sorted

Logical TRUE/FALSE. Should the keys be arranged alphabetically?

Value

A vector of characters with the names of the valid keys to be used on a Citation File Format version 1.2.0

Source

Guide to Citation File Format schema version 1.2.0.

Examples

cff_schema_keys(sorted = TRUE)

# Valid Licenses keys
head(cff_schema_keys_license(), 20)

cff_schema_definitions_person()

cff_schema_definitions_entity()

cff_schema_definitions_refs()

cffr documentation built on April 3, 2025, 9:33 p.m.