Template:Infobox/dataset

This page holds the JSON Schema for infobox: type: dataset, used by data source pages (the star catalogue, the known black hole list) (the field list follows SCIENCE_CORPUS 3.2 Reference). Every page whose frontmatter names this type is validated against it on save: a schema error blocks a save by a new account or an API client and warns a trusted editor.

Values are flexible so that writers can record what the sources allow. A field may be plain text or a number, a quantity object {value, unit, min, max, error, source, note}, or a by-status mapping {observed, model, sim} when the measured, inferred and generated values differ. Fields not listed here are allowed and shown under "Other" in the infobox. The x-pax block carries display metadata: the groups in order, each group's default provenance tag, and the label and unit for every field.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://paxabyssi.com/wiki/Template:Infobox/dataset",
  "title": "Dataset",
  "description": "Infobox for data source pages (the star catalogue, the known black hole list). Fields follow SCIENCE_CORPUS 3.2 Reference.",
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "const": "dataset"
    },
    "image": {
      "$ref": "#/$defs/fileTitle",
      "description": "Lead image, a File: title."
    },
    "caption": {
      "type": "string"
    },
    "image_caption": {
      "type": "string"
    },
    "base_catalogue": {
      "$ref": "#/$defs/field"
    },
    "internal_file": {
      "$ref": "#/$defs/field"
    },
    "licence": {
      "$ref": "#/$defs/field"
    },
    "rows": {
      "$ref": "#/$defs/field"
    },
    "columns": {
      "$ref": "#/$defs/field"
    },
    "coordinates": {
      "$ref": "#/$defs/field"
    },
    "completeness": {
      "$ref": "#/$defs/field"
    },
    "rows_with_a_distance": {
      "$ref": "#/$defs/field"
    },
    "gaia_dr3_distances_rows": {
      "$ref": "#/$defs/field"
    },
    "median_gaia_parallax_uncertainty_percent": {
      "$ref": "#/$defs/field"
    },
    "spectral_type_rows": {
      "$ref": "#/$defs/field"
    },
    "corrected_spectral_type_rows": {
      "$ref": "#/$defs/field"
    },
    "metallicity_rows_xhip": {
      "$ref": "#/$defs/field"
    },
    "age_rows_xhip": {
      "$ref": "#/$defs/field"
    },
    "wds_cross_matched_stars": {
      "$ref": "#/$defs/field"
    },
    "proper_names": {
      "$ref": "#/$defs/field"
    },
    "naked_eye_stars_v_le_6": {
      "$ref": "#/$defs/field"
    },
    "correction_sources": {
      "$ref": "#/$defs/field"
    }
  },
  "additionalProperties": true,
  "$defs": {
    "quantity": {
      "type": "object",
      "description": "A number or range with its unit and provenance.",
      "properties": {
        "value": {
          "type": [
            "number",
            "string",
            "null"
          ]
        },
        "unit": {
          "type": "string"
        },
        "min": {
          "type": [
            "number",
            "string"
          ]
        },
        "max": {
          "type": [
            "number",
            "string"
          ]
        },
        "error": {
          "type": [
            "number",
            "string"
          ]
        },
        "uncertainty": {
          "type": [
            "number",
            "string"
          ]
        },
        "source": {
          "type": "string",
          "description": "observed | model | sim | catalogue | fiction, or a citation."
        },
        "note": {
          "type": "string"
        },
        "as_of": {
          "type": [
            "string",
            "number"
          ]
        }
      },
      "additionalProperties": true
    },
    "byStatus": {
      "type": "object",
      "description": "The same quantity as measured (observed), inferred (model) and generated (sim).",
      "properties": {
        "observed": {
          "$ref": "#/$defs/cell"
        },
        "model": {
          "$ref": "#/$defs/cell"
        },
        "sim": {
          "$ref": "#/$defs/cell"
        },
        "note": {
          "type": "string"
        }
      },
      "additionalProperties": true
    },
    "cell": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "type": "null"
        },
        {
          "type": "array"
        },
        {
          "$ref": "#/$defs/quantity"
        }
      ]
    },
    "field": {
      "anyOf": [
        {
          "$ref": "#/$defs/cell"
        },
        {
          "$ref": "#/$defs/byStatus"
        },
        {
          "type": "object"
        }
      ]
    },
    "fileTitle": {
      "type": "string",
      "pattern": "^File:"
    },
    "status": {
      "description": "One or more of observed, model, sim, speculative, fiction; or a sentence saying which parts carry which label.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    }
  },
  "x-pax": {
    "label": "Dataset",
    "image_field": "image",
    "caption_field": "caption",
    "groups": [
      {
        "index": "01",
        "title": "Identity",
        "fields": [
          "base_catalogue",
          "internal_file",
          "licence",
          "rows",
          "columns",
          "coordinates",
          "completeness"
        ],
        "provenance": "catalogue"
      },
      {
        "index": "02",
        "title": "Coverage",
        "fields": [
          "rows_with_a_distance",
          "gaia_dr3_distances_rows",
          "median_gaia_parallax_uncertainty_percent",
          "spectral_type_rows",
          "corrected_spectral_type_rows",
          "metallicity_rows_xhip",
          "age_rows_xhip",
          "wds_cross_matched_stars",
          "proper_names",
          "naked_eye_stars_v_le_6",
          "correction_sources"
        ],
        "provenance": "catalogue"
      }
    ],
    "fields": {
      "base_catalogue": {
        "label": "Base catalogue"
      },
      "internal_file": {
        "label": "Internal file"
      },
      "licence": {
        "label": "Licence"
      },
      "rows": {
        "label": "Rows"
      },
      "columns": {
        "label": "Columns"
      },
      "coordinates": {
        "label": "Coordinates"
      },
      "completeness": {
        "label": "Completeness"
      },
      "rows_with_a_distance": {
        "label": "Rows with a distance"
      },
      "gaia_dr3_distances_rows": {
        "label": "Rows with Gaia DR3 distances"
      },
      "median_gaia_parallax_uncertainty_percent": {
        "label": "Median Gaia parallax uncertainty",
        "unit": "%"
      },
      "spectral_type_rows": {
        "label": "Rows with a spectral type"
      },
      "corrected_spectral_type_rows": {
        "label": "Rows with a corrected spectral type"
      },
      "metallicity_rows_xhip": {
        "label": "Metallicity rows (XHIP)"
      },
      "age_rows_xhip": {
        "label": "Age rows (XHIP)"
      },
      "wds_cross_matched_stars": {
        "label": "WDS cross-matched stars"
      },
      "proper_names": {
        "label": "Proper names"
      },
      "naked_eye_stars_v_le_6": {
        "label": "Naked-eye stars (V ≤ 6)"
      },
      "correction_sources": {
        "label": "Correction sources"
      }
    }
  }
}