Module Documentation: eml-dataset
Back to EML Contents
The eml-dataset module - Dataset specific information

The eml-dataset module contains general information that describes dataset resources. It is intended to provide overview information about the dataset: broad information such as the title, abstract, keywords, contacts, maintenance history, purpose, and distribution of the data themselves. The eml-dataset module also imports many other modules that are used to describe the dataset in fine detail. Specifically, it uses the eml-methods module to describe methodology used in collecting or processing the dataset, the eml-project module to describe the overarching research context and experimental design, the eml-access module to define access control rules for the data and metadata, and the eml-entity module to provide detailed information about the logical structure of the dataset. A dataset can be (and often is) composed of a series of data entities (tables) that are linked together by particular integrity constraints.

The eml-dataset module, like other modules, may be "referenced" via the <references> tag. This allows a dataset to be described once, and then used as a reference in other locations within the EML document via its ID.

Module details
Recommended Usage: all datasets
Stand-alone: yes
Imports: eml-documentation, eml-resource, eml-party, eml-access, eml-entity, eml-dataTable, eml-project, eml-methods, eml-spatialRaster, eml-spatialVector, eml-storedProcedure, eml-text, eml-view
Imported By:
View an image of the schema: eml-dataset image

Element Definitions:

dataset  This element has no default value.
Content of this field: Description of this field:
Type: DatasetType
The dataset field encompasses all information about a single dataset. A dataset is defined as all of the information describing a data collection event. This event may take place over some period of time and include many actual collections (a time series or remote sensing application) or it could be just one actual collection (a day in the field).
purpose  This element has no default value.
Content of this field: Description of this field:
Type: txt:TextType
A description of the purpose of this dataset. Note that this element requires DocBook style formatting. See eml-text for more information.
maintenance  This element has no default value.
Content of this field: Description of this field:
Type: MaintenanceType
A description of the maintenance of this data resource. This includes information about the frequency of update, and whether there is ongoing data collection.
contact  This element has no default value.
Content of this field: Description of this field:
Type: rp:ResponsibleParty
The contact field contains contact information for this dataset. This is the person or institution to contact with questions about the use, interpretation of a data set.
publisher  This element has no default value.
Content of this field: Description of this field:
Type: rp:ResponsibleParty
The publisher of this data set. At times this is a traditional publishing house, but it may also simply be an institution that is making the data available in a published (ie, citable) format.
pubPlace  This element has no default value.
Content of this field: Description of this field:
Type: res:NonEmptyStringType
The pubPlace field is the location where the resource was published, which may be different from where the resource was created.
Example(s):
San Francisco, CA, USA
New York, NY, USA
methods  This element has no default value.
Content of this field: Description of this field:
Type: md:MethodsType
The methods field documents scientific methods used in the collection of this dataset. It includes information on items such as tools, instrument calibration and software.
project  This element has no default value.
Content of this field: Description of this field:
Type: proj:ResearchProjectType
The project field contains information on the project in which this dataset was collected. It includes information such as project personnel, funding, study area, project design and related projects. The project description can also contain documentation on subprojects.
dataTable  This element has no default value.
Content of this field: Description of this field:
Type: dat:DataTableType
The dataTable field documents the dataTable(s) that make up this dataset. A dataTable could be anything from a Comma Separated Value (CSV) file to a spreadsheet to a table in an RDBMS.
spatialRaster  This element has no default value.
Content of this field: Description of this field:
Type: sr:SpatialRasterType
The spatialRaster field describes any spatial raster images included in this dataset.
spatialVector  This element has no default value.
Content of this field: Description of this field:
Type: sv:SpatialVectorType
The spatialVector field describes any spatial vectors included in this dataset.
storedProcedure  This element has no default value.
Content of this field: Description of this field:
Type: sp:StoredProcedureType
The storedProcedure field contains information about any stored procedures included with this dataset. This usually implies that the dataset is stored in a DBMS or some other data management system capable of processing your dataset.
view  This element has no default value.
Content of this field: Description of this field:
Type: v:ViewType
The view field contains information about any view included with this dataset. This usually implies that the dataset is stored in a DBMS or some other data management system capable of processing your dataset.
otherEntity  This element has no default value.
Content of this field: Description of this field:
Type: ent:OtherEntityType
The otherEntity field contains information about any entity in the dataset that is not any of the preceding entities. (i.e. it is not a table, spatialRaster, spatialVector, storedProcedure or view.) OtherEntity allows the documentation of basic entity fields as well as a plain text field to allow you to type your entity.
description  This element has no default value.
Content of this field: Description of this field:
Type: txt:TextType
A text description of the maintenance of this data resource. Note that this field must be marked up using DocBook like tagging. See eml-text for more information.
maintenanceUpdateFrequency  This element has no default value.
Content of this field: Description of this field:
Type: MaintUpFreqType
Frequency with which changes and additions are made to the dataset after the initial dataset is completed. The values for this field must come from the enumeration MaintUpFreqType.
changeHistory  This element has no default value.
Content of this field: Description of this field:
Elements: Use: How many:
A sequence of (
changeScoperequired
oldValuerequired
changeDaterequired
commentoptional
)
A description of changes made to the data since its release.
changeScope  This element has no default value.
Content of this field: Description of this field:
Type: res:NonEmptyStringType
The expression should unambiguously identify the entity(s) and attribute(s) that were changed.
oldValue  This element has no default value.
Content of this field: Description of this field:
Type: res:NonEmptyStringType
The previous value or an expression that describes the previous value of the data.
changeDate  This element has no default value.
Content of this field: Description of this field:
Type: xs:date
The date the changes were applied.
comment  This element has no default value.
Content of this field: Description of this field:
Type: res:NonEmptyStringType
Explanation or justification for the change made to the data.

Attribute Definitions:

id

Type: res:IDType

Use: optional

system

Type: res:SystemType

Use: optional

scope

Type: res:ScopeType

Use: optional

Default value: document

Complex Type Definitions:

DatasetType 
Content of this field: Description of this field:
Elements: Use: How many:
A choice of (
A sequence of (
res:ResourceGroup  
purposeoptional
maintenanceoptional
contactrequiredunbounded
publisheroptional
pubPlaceoptional
methodsoptional
projectoptional
A choice of (
dataTablerequired
OR
spatialRasterrequired
OR
spatialVectorrequired
OR
storedProcedurerequired
OR
viewrequired
OR
otherEntityrequired
)
)
OR
res:ReferencesGroup  
)
Attributes: Use: Default Value:
idoptional
systemoptional
scopeoptionaldocument
DatasetType is the base type for the dataset element. The dataset field encompasses all information about a single dataset. A dataset is defined as all of the information describing a data collection event. This event may take place over some period of time and include many actual collections (a time series or remote sensing application) or it could be just one actual collection (a day in the field).
MaintenanceType 
Content of this field: Description of this field:
Elements: Use: How many:
A sequence of (
descriptionrequired
maintenanceUpdateFrequencyoptional
changeHistoryoptionalunbounded
)
The maintenance type defines the fields for the maintenance element.

Simple Type Definitions:

MaintUpFreqType

Derived from: xs:string (by xs:restriction)

Allowed values:

  • annually
  • asNeeded
  • biannually
  • continually
  • daily
  • irregular
  • monthly
  • notPlanned
  • weekly
  • unkown
  • otherMaintenancePeriod

Group Definitions:

Web Contact: jones@nceas.ucsb.edu