DATA SET DOCUMENTATION (i.e., "Readme" file)
The documentation (i.e., the "Readme" file) that accompanies each project data set is as
important as the data itself. This information permits collaborators and other analysts to
become aware of the data and to understand any limitations or special characteristics of data
that may impact its use elsewhere. The data set documentation should accompany all data set
submissions and contain the information listed in the outline below. While it will not be
appropriate for each and every data set to have information in each documentation category,
the following outline (and content) should be adhered to as closely as possible to make the
documentation consistent across all data sets. It is also recommended that a documentation
file submission accompany for each preliminary and final data set.
TITLE: This should match the data set name
AUTHOR(S):
Name(s) of PI and all co-PIs
Complete mailing address, telephone/facsimile Nos.,
E-mail address of PIs, and WWW address (if applicable)
Similar contact information for data questions (if different than above)
1.0 DATA SET OVERVIEW:
Introduction or abstract
Time period covered by the data
Physical location (including lat/lon/elev) of the measurement or platform
Data source if applicable (e.g., for operational data include agency)
Any World Wide Web address references (i.e., additional documentation such as Project WWW site)
2.0 INSTRUMENT DESCRIPTION:
Brief text (i.e., 1-2 paragraphs) describing the instrument with references
Figures (or links), if applicable
Table of specifications (i.e., accuracy, precision, frequency, resolution, etc.)
3.0 DATA COLLECTION AND PROCESSING:
Description of data collection
Description of derived parameters and processing techniques used
Description of quality control procedures
Data intercomparisons, if applicable
4.0 DATA FORMAT:
Data file structure and file naming conventions (e.g., column delimited ASCII, NetCDF, GIF, JPEG, etc.)
Data format and layout (i.e., description of header/data records, sample records)
List of parameters with units, sampling intervals, frequency, range
Data version number and date
Description of flags, codes used in the data, and definitions (i.e., good, questionable, missing, estimated, etc.)
5.0 DATA REMARKS:
PI's assessment of the data (i.e., disclaimers, instrument problems, quality issues, etc.)
Missing data periods
Software compatibility (i.e., list of existing software to view/manipulate the data)
6.0 REFERENCES:
List of documents cited in this data set description