FAIR research-object metadata and exports — fair-research-object • popgenVCF

Create validated FAIR metadata for a reproducible popgenVCF project and export RO-Crate, CodeMeta, DataCite JSON, CITATION.cff, and checksummed bundle manifests.

Usage

new_fair_creator(
  name,
  orcid = NA_character_,
  affiliation = NA_character_,
  email = NA_character_
)

fair_identifier(project, artifact_id = NULL)

new_fair_metadata(
  project,
  title = project$name,
  description = "Reproducible population-genomics analysis",
  creators = list(),
  license = "MIT",
  keywords = c("population genetics", "VCF", "reproducibility"),
  publisher = "popgenVCF",
  publication_year = as.integer(format(Sys.Date(), "%Y")),
  rights_uri = NA_character_
)

validate_fair_metadata(x)

fair_documents(metadata)

write_fair_bundle(metadata, directory, overwrite = FALSE)

validate_fair_bundle(directory)

set_project_fair_metadata(project, metadata)

Arguments

name: Creator name.
orcid: Optional ORCID identifier.
affiliation: Optional affiliation.
email: Optional email address.
project: A PopgenVCFProject.
artifact_id: Optional artifact identifier.
title: Project title.
description: Project description.
creators: Creator records from new_fair_creator().
license: SPDX identifier or license URL.
keywords: Character keywords.
publisher: Publisher or repository.
publication_year: Publication year.
rights_uri: Optional explicit license URI.
x: A PopgenVCFFAIRMetadata.
metadata: Validated FAIR metadata.
directory: Output directory.
overwrite: Permit replacement of a non-empty output directory.

Value

Creator and metadata constructors return validated records. fair_documents() returns plain standards-facing records. Writers return normalized paths invisibly; validators return TRUE or fail with an integrity error.

Details

The immutable VCF/project identity remains authoritative. Project URNs derive from the project UUID, while artifact URNs derive from the project UUID and immutable artifact identifier. Complete metadata remains in project RDS bundles; JSON-facing records contain only plain serializable values.