Construct a cybed:Framework top-level node

Every framework rendered through cybedtools produces exactly one of these nodes. Downstream Role and RoleElement nodes attach to it via cybed:partOf.

Usage

build_framework_node(
  framework_id,
  framework_name,
  framework_prefix,
  version,
  publisher,
  jurisdiction,
  sector,
  specificity,
  license = NA_character_,
  date_published = NA_character_,
  attribution = NA_character_,
  in_language = NA_character_
)

Arguments

framework_id

Character, internal identifier (e.g., "nice-v2", "ecf-2.0", "ecsf-2022", "sfia-9", "dcwf-2024").

framework_name

Character, human-readable name.

framework_prefix

Character, the Tier 2 prefix for this framework.

version

Character, publisher version string.

publisher

Character, publisher name.

jurisdiction

Character: "US", "EU", "UK", "global", or an ISO 3166-1 alpha-2 country code for a national framework (e.g., "CZ", "CA", "SG").

sector

Character, one of "civilian", "defense", "general".

specificity

Character, one of "general-IT", "cybersecurity-specific".

license

Character, license URI or SPDX identifier.

date_published

Character, ISO-8601 date.

attribution

Character, the attribution statement the framework's steward requires, recorded verbatim as schema:creditText. Supply it exactly as the steward worded it.

in_language

Character, BCP 47 language tag of the framework's statement text (e.g., "cs"), recorded as schema:inLanguage. Omit for English-language frameworks.

Value

Named list (JSON-LD node) describing the framework.

See also

Other JSON-LD construction: assemble_framework_document(), build_jsonld_context(), build_multi_framework_context(), build_organizing_unit_node(), build_related_unit_metadata(), build_role_element_node(), build_role_node(), build_unit_relation_node()

Examples

fw <- build_framework_node(
  framework_id     = "nice-v2",
  framework_name   = "NICE Framework v2",
  framework_prefix = "nice",
  version          = "2.0.0",
  publisher        = "NIST",
  jurisdiction     = "US",
  sector           = "civilian",
  specificity      = "cybersecurity-specific"
)
fw[["@id"]]
#> cybed:framework/nice-v2
fw[["@type"]]
#> [1] "nice:Framework"  "cybed:Framework"