schema.codebookschema.md
January 18, 2023 ยท View on GitHub
Home > @datashaper/schema > CodebookSchema
CodebookSchema interface
This contains all of the field-level details for interpreting a dataset, including data types, mapping, and metadata. Note that with persisted metadata and field examples, a dataset can often be visualized and described to the user without actually loading the source file. resource profile: 'codebook'
Signature:
export interface CodebookSchema extends ResourceSchema
Extends: ResourceSchema
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| fields | Field[] | The per-field encodings. These contain interpretive information about the data. | |
| profile | KnownProfile.Codebook |