Annotated Outline of Data Set User’s Guide

Data Set Documentation includes fully descriptive information about a data set: the premise behind the collection activity, abstract, data collection instruments, analysis methods, quality control procedures, calibration information, known problems with the data, file structure and format information, column names and descriptions, measurement units, requested citation, data contacts, and related data sets. The data set documentation should provide enough information that a user who is completely removed from the original data collection activity in space and time can read the documentation, understand the data, and evaluate the usefulness of the data for his or her current purposes.

 

This information may be input into and then exported (in the format you see here) from the LBA Metadata Editor (LME).  If you would like to include images, tables, or other special formats, you can use the LME to input the basic information and then, using your Browser “Save As” function, save the file to your desktop to be completed using your preferred html editor. 


Title

(Loaded automatically from the "Data Set Title" field in the LME metadata file in the LME. You do not have to enter it again.)

 

Summary: 

(Loaded automatically from the "Description" field in the LME metadata file. You do not have to enter it again.)

Summary Guidance:  A summary of the contents of this data set to orient the reader immediately on display. This is similar to the abstract of a published paper. A person reading the summary should be able to quickly ascertain the “who, what, when, where, and why” of the data set and decide whether to read further. In many cases, more people will read the summary than will read the entire document and obtain the data set. Thus, the summary should be completely self-explanatory and intelligible in itself. It should include the following:

· Reason for producing data collection, including rationale or justification for the research

· Objectives, location, and timeframe

· Brief description of methods used

· Results and conclusions

· General description of data files (number and format)

· Acknowledgement of sponsor.

Data Citation:

(Loaded automatically from the “Data Set Citation” field in the LME metadata file. You do not have to enter it again.)

Cite this data set as follows:

Author1, A.B., C. D.Author2, E. Author3, F.Author4, and G.H. Author5. 2006. Title of the data set. Available on-line [http://daac.ornl.gov] from Oak Ridge National Laboratory Distributed Active Archive Center, Oak Ridge, Tennessee, USA

Table of Contents:

(Constructed automatically)

1. Data Set Overview:

This section should include the following information, if applicable.  The following sub-headings may optionally be used to organize your information.

Data Set Contents:

Briefly describe the data set contents.

Related Data Sets:

List and indicate sources of similar or related data that are generally available from the data archives.

Title of Investigation:

The title of the study or campaign for which the data collection was made.

Investigator(s) Name and E-mail:

Name

The full name and title of an investigator associated with a data set.

(Loaded automatically from the "Investigator" field in the LME metadata file. You do not have to enter it again.)

 

Email

Short form for electronic mail.

(Loaded automatically from the " Investigator" field in the LME metadata file. You do not have to enter it again.)

 

Technical Contact(s) Name, Telephone, and E-mail:

Name

Those persons most knowledgeable about the actual collection and processing of the data set. In many cases this will be a person (or persons), other than the Principal Investigator, who prepared the data for submission and are sufficiently knowledgeable about the data, to answer technical questions about it. The full name and title of an investigator associated with a data set.

(Loaded automatically from the "Contact Person" field in the LME metadata file. You do not have to enter it again.)

 

Email

Short form for electronic mail.

(Loaded automatically from the " Contact Person " field in the LME metadata file. You do not have to enter it again.)

 

Phone

Complete telephone number. May have spaces or dashes embedded.

(Loaded automatically from the " Contact Person " field in the LME metadata file. You do not have to enter it again.)

 

Future Modifications and Plans:

Description of future plans-reprocessing, increasing temporal or spatial coverage, etc. For these data sets the Guide Document shall inform the user to call the Data Center User Services Office for up-to-date information on the status of the data (e.g., if there has been any changes in the operational procedures, etc.). If there are no such plans, state that processing is complete.

2. Data Characteristics:

This section should include the following information, if applicable.  The following sub-headings may optionally be used to organize your information.

Study Area

Describe the location of the terrain or space over which the data were collected.

·       Spatial Coverage:

Indicate the total area covered by each measurement or set of measurements. Also give enough information to locate the geographic position of the measurement with suitable precision. Also include description of any spatial data gaps.

·       Spatial Resolution:

Describe the extent to which the terrain has been resolved into constituent or elementary parts.

·       Projection:

Describe the projection used in processing the data as appropriate. This generally applies to model/image/remote sensing or GIS data products processed to levels 3 and/or 4. Include all pertinent information -- projection, datum, ellipsoid, units, and other parameters as needed.

·       Grid Description:

Describe the method and procedure for gridding and/or binning the data.

    Temporal Coverage:

Describe the period of time which the data collection covered, more or less continuously. Also includes description of temporal data gaps. For data that are continually being collected, the Guide shall specify time coverage by providing a begin date and then state to present. Provide one or more paragraphs describing the temporal characteristics of this data set.

Describe the optimum and typical intervals between measurements during the periods of data collection. This can be the sampling frequency for an instrument and the intervals between measurement periods. It can also be the length of time it takes to collect an entire sample or scan.

Parameters or Variables:

Give a complete list of the names of the variables or parameters in the data set and the other descriptors. Include all measured, recorded, and calculated variables. If a variable is encoded, then describe the structure and define the code values.  Describe variable coded values, missing values, or other information important to the understanding of measured or calculated variables.  Complete information about a variable includes:

o      Variable

 Name of the variable or parameter as it appears in the data file.

o      Description

This is the definition of the variable as used in the data file.

o      Units

Please use SI units or units commonly employed by scientific community.

o      Instrument

This is the instrument which collected the data e.g., rain gauge, streamflow weir, etc.

o      Range

This is the range of data values that exist for the data, both numeric and character values. A list of valid values for codes that need explaining should be entered into a footnote. Missing (fill) values should be included in this field and an explanation given in a footnote (e.g., if -999 is the missing value, that should be clearly indicated here.)

 

Data Organization

Describe the organization of the data files, data file formats, variable descriptions, and a sample data record, if applicable.

Indicate the format used for storing the data. This documentation may be in external files, which should be described here so that the curators of the archived data and documentation will know that they must provide a way for the ultimate user to access them.

Provide a few lines of an actual data file. Cut and paste header rows and at least two data rows. Wrap lines as needed to fit document format and for effective presentation. May not be applicable to imagery data (binary). Inventory data files of available imagery products are appropriate.

3. Application and Derivation:

This section should include the following information, if applicable.  The following sub-headings may optionally be used to organize your information.

Typical Application of Data

Describe to what kind of research the data can be applied. Give instances where the data was used.

Theory of Measurements

Theoretical basis for the way in which the measurements were made for all data used in creating this data set.

Derivation Techniques and Algorithms

Describe any special techniques or algorithms used. This section contains detailed descriptions and references on models and derivation techniques.

Formulae:

Describe any special techniques or algorithms used. This section contains detailed descriptions and references on models and derivation techniques.

List any formulae required in processing the data.

Processing Steps:

Indicate the sequence of processing steps that the PI applied to the data, that are available and are described in this document. If the data are processed internal to the instrumentation you do not need to describe that processing in great detail here. This section should concentrate on the processing that is actually done by the Principal Investigator.

Processing Changes:

For long-term, repetitive, or revised data sets; give a HISTORY of changes in the processing sequence. Information on changes to models should go in this section. If an earlier processed version is not in this Data collection and is no longer available then it should be described here as part of the HISTORY of changes. For higher-level products this begins with the steps to acquire the data for the products described in the document.

Special corrections/Adjustments:

These are the calculations that are above and beyond the routine/normal formulas and processing sequence described in 'Formulas' and 'Data Processing Sequence' sections above.

Calculated Variables:

List all calculated variables throughout the data processing and make sure their formulae are provided in 'Derivation Techniques/Algorithms' section.

Graphs and Plots Used in Analysis:

Provide or reference any graphs, plots, viewer images, or thumbnails associated with analysis of the data, if any.

4. Quality Assessment:

This section should include the following information, if applicable.  The following sub-headings may optionally be used to organize your information.

Data Usage Guidance:

Provide one or more paragraphs describing data usage guidance activities.

Errors and Limitations:

Error Sources:

Provide descriptions of data usage guidance under the following subheadings.

Describe what factors of the instrument or environment may introduce errors in the observations. These errors are specific to the product that is in the data set being described.

Note: For higher level data sets, this section DOES NOT include errors that occur in channels or parameters from the original instrument that are not used in creating the data set being described. For example, if TM channels 2-4 where used to create a higher level data set then errors in channels 1 and 5 would not be described in the document for that higher level data set, but errors for channels 2-4 would be described.

Limitations of the Data:

Are there cases or situations when the algorithm is unreliable?

Known Problems with the Data:

List known problems and discrepancies in the Data collection. If none have been reported, state that fact (i.e., None reported at this revision.)

Quality Assessment Activities

Provide one or more paragraphs describing quality assessment activities.

Validation by Submitter of Data:

Provide descriptions of data quality assessment activities under the following subheadings.

Describe all efforts to validate the data by the submitter.

Confidence Level or Accuracy Judgment:

Subjective discussion of data quality. If the source of an error is unknown that should be explicitly stated in this section.

Measurement Error for Parameters:

Provide any quantitative error estimates.

Additional Quality Assessments:

Include any Quality Assessment at the Data Center.

Verification by Data Center:

Describe the verification procedures at the Data Center after transfer of data (this is especially important with electronic transfers). Provide verification statistics

Other Relevant Information about the Study:

Provide any additional information that will assist a user in understanding and interpreting the data.

5. Acquisition Materials and Methods:

This section should include the following information, if applicable.  The following sub-headings may optionally be used to organize your information.

 

This section will tend to have a different organization for remote sensing data (typically collected from an aerial or space-based platform) than for field measurements. 

6. Data Access:

(Constructed automatically and modified as needed by the curator of the data set archive.)

Data Access:

This data is available through the Oak Ridge National Laboratory (ORNL) Distributed Active Archive Center (DAAC) or the EOS Data Gateway.

Data Archive Center:

Contact for Data Center Access Information:

E-mail: uso@daac.ornl.gov
Telephone: +1 (865) 241-3952
FAX: +1 (865) 574-4665

Product Availability:

Requested data can be provided electronically on the ORNL DAAC's anonymous FTP site or on various media including, CD-ROMs, 8-MM tapes, or diskettes.

7. References:

Provide references to Satellite/Instrument/Data Processing Documentation, Journal Articles and Study Reports, and Data Center/Database Management System Usage Documentation.

Use the format used in leading science Journals. If these documents exist online, refer to Bibliography Styles from the University of Illinois Writers' Workshop On-Line Handbook. URL: http://www.english.uiuc.edu/cws/wworkshop/bibliostyles.htm.

Related Publications
(Loaded automatically from the " Related Publications" field in the LME metadata file. You do not have to enter it again.)