Skip to content

Define and ship the catalog data model #5

Description

@larnsce

Goal

Three tibbles, shipped as the internal object owd_catalog in R/sysdata.rda and exported as CSV for the website.

Rewritten 2026-09-04 per dev/decisions-2026-09.md.

owd_packages (all detected packages)

column type provenance
pkg_name chr DESCRIPTION Package
title chr DESCRIPTION Title
description chr DESCRIPTION Description, whitespace-collapsed
version chr DESCRIPTION Version, leading v stripped
published lgl Zenodo DOI (10.5281/zenodo.*) present in CITATION.cff
reviewed lgl NA until the pkgreview check is wired; then TRUE when the review issues are closed
maintainer chr Authors@R role cre, "Given Family"
maintainer_orcid chr Authors@R comment ORCID
authors chr all aut/cre collapsed with "; "
license chr DESCRIPTION License
date Date DESCRIPTION Date, NA-tolerant
keywords chr X-schema.org-keywords, GitHub topics as fallback
spatial_coverage chr X-schema.org-spatialCoverage, NA if absent
temporal_coverage chr X-schema.org-temporalCoverage, NA if absent
doi chr CITATION.cff doi, NA if absent
cff_version chr CITATION.cff version, drift diagnostic
url_github chr constructed, cross-checked with DESCRIPTION URL
url_docs chr https://openwashdata.github.io/[pkg]/
n_datasets int count of data/*.rda
latest_release chr GitHub releases/latest tag, NA if none
default_branch chr GitHub repos API
created_at, last_commit Date GitHub repos API
topics chr GitHub topics, collapsed
has_dictionary, has_extdata lgl contents listing

The columns the website renders today (name, location, status, description, published date, website link, maintainer, DOI, temporal coverage, keywords) all have a source here. spatial_coverage is the website's location column, published is its status column.

owd_datasets (published packages only)

pkg_name, dataset_name, title, description, n_rows, n_vars (from @Format), n_vars_dictionary (cross-check), csv_url, xlsx_url (raw.githubusercontent on the default branch, NA when the file does not exist).

owd_variables (published packages only)

pkg_name, dataset_name, variable_name, variable_type (first class only), description.

Outputs of a harvest

  • R/sysdata.rda: owd_catalog, a list of meta (harvest_date, org, backend), the three tibbles, and the prebuilt search index
  • inst/extdata/owd_packages.csv, owd_datasets.csv, owd_variables.csv, UTF-8, na = ""
  • No xlsx, no catalog.json, no files table

Acceptance criteria

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions