Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type CSVW ¶
type CSVW struct { Context string `json:"@context"` URL string `json:"url"` Title string `json:"dct:title"` Description string `json:"dct:description,omitempty"` Issued string `json:"dct:issued,omitempty"` Publisher Publisher `json:"dct:publisher,omitempty"` Contact []Contact `json:"dcat:contactPoint,omitempty"` TableSchema Columns `json:"tableSchema"` Theme string `json:"dcat:theme,omitempty"` License string `json:"dct:license,omitempty"` Frequency string `json:"dct:accrualPeriodicity,omitempty"` Notes []Note `json:"notes,omitempty"` // New fields Downloads map[string]Download `json:"dcat:distribution,omitempty"` Keywords []string `json:"dcat:keyword,omitempty"` UnitOfMeasure string `json:"dcat:conformsTo,omitempty"` Version int `json:"dcat:version,omitempty"` IsBasedOn string `json:"prov:wasGeneratedBy,omitempty"` DatasetLinks *DatasetLinks `json:"dcat:record,omitempty"` }
CSVW provides a structure for describing a CSV through a JSON metadata file. The JSON tags feature web vocabularies like Dublin Core, DCAT and Stat-DCAT to help further contextualize and define the metadata being provided. The URL field in the CSVW must reference a CSV file, and all other data should describe that CSVs contents.
type Column ¶
type Column map[string]interface{}
Column provides the ability to define the JSON tags required specific to each column within the CSVW
type Contact ¶
type Contact struct { Name string `json:"vcard:fn"` Telephone string `json:"vcard:tel"` Email string `json:"vcard:email"` }
Old fields Contact represents a response model within a dataset
type DatasetLinks ¶ added in v1.6.0
type DatasetLinks struct { Editions Link `json:"editions"` LatestVersion Link `json:"latestVersion"` Self Link `json:"self"` }
New fields
type Error ¶
type Error struct {
// contains filtered or unexported fields
}
Error is the packages error type
type Note ¶
type Note struct { Type string `json:"type"` // is this an enum? Target string `json:"target,omitempty"` Body string `json:"body"` Motivation string `json:"motivation,omitempty"` // how is this different from type? do we need this? is this an enum? }
Note can include alerts, corrections or usage notes which exist in the dataset metadata and help describe the contents of the CSV