You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Introduction

The ASCII File Format Guidelines for Earth Science Data lists recommended practices for formatting and describing ASCII encoded data files, such that the files will be self-describing and adhere to common conventions.  Included recommendations address: General Structure, Header Information, Data Information, Location Information, Time Information, Missing Data, Limits of Detection, and Filenames.

This table is taken from the checklist in Appendix B of that document. The checklist summarizes the requirements and recommendations contained in the document. File formats that have been vetted with the checklist appear in the columns to the right of the checklist items. To see more information about these file formats, click on the name of the format in the table, or in the list of formats below.

Formats

  • SeaBASS

 

SectionRequirement / RecommendationSeaBASS  

General
Requirements

Create files with separate header and data sections – R1y  
Use a consistent delimiter between data values throughout the file – R1y  

Use escape mechanism if the designated delimiter character appears in text or data – R1

y  
Separate lines of text and rows of data with end-of-line (EOL) character(s), used consistently throughout the file – R1y  
General
Recommendations
Use the standard US-ASCII character set, without extensions – R1y  
Avoid ASCII control characters, except tab or EOL characters – R1y  
Do not use empty lines or rows – R1y  
Chose delimiter character to avoid need for escape mechanism – R1-  
Terminate file with same end-of-line (EOL) character(s) used to separate data rows – R1-  
Use unique, descriptive file names – R7-  
Header Section
Required 
Clearly delineate header section as described in this document – R2y  
List unique variable names (columns) – R2y  
Define units of measure for each variable – R2y  
Identify community-specific convention used for data representation and/or units of measure, if applicable – R3 y  
Specify conventions used for latitude, longitude, and elevation if applicable – R4y  
Identify type of elevation measurement used, if applicable – R4y  
Indicate which data grid index runs faster, if applicable – R3-  
Reference any additional documentation needed to understand the data in the file, preferably by DOI – R2y  
Specify time representation if not using ISO 8601 – R5-  
Specify time zone and offset if using local time instead of UTC or GMT – R5-  
Specify single location or time associated with all data in the file, if not specified with each data row – R3y  
Define missing or out of bounds data fill values, any other flag values – R6y  
Header Section
Recommended 
Provide as much metadata as practical, all metadata if possible – R2y  
For each variable, provide long and short names and description – R2-  
Describe gridding scheme used, if applicable – R3-  
Define geographic reference frame and ellipsoid – R4n  
Specify coordinate reference system, and datum if applicable – R4n  
Document type of location information used – R4y  
Document location of GPS antenna on aircraft, if applicable – R4-  
Provide geographic coordinates for place name associated with data – R4y  
Define time base information, including source of time stamps – R5-  
Identify time zone from IANA Time Zone Database if using local time – R5-  
Specify whether time stamps identify start, stop, midpoint or average of measurement period – R5-  
For averaged or derived products, indicate data collection window – R5-  
Indicate whether internal computer clocks are synchronized to GPS time or other – R5-  
Provide principal investigator name and contact information – R2y  
Provide uncertainty information – R2n  
Indicate dates of data collection and processing – R2y  
Provide a record of data revision – R2y  
Provide data DOI if available – R2-  
Data Section
Required 
Organize data as matrix of rows and columns – R1 y  
Provide geographic location and/or time tag (as applicable) for each data row or value – R3, R4, R5y  
Use a designated flag value to indicate missing data when using space or tab delimiters – R1, R6y  
Do not use daylight savings time if using local time instead of UTC or GMT – R5-  
Data Section
Recommended 
Provide lat/lon in format applicable to coordinate reference system used – R4y  
Provide elevation for each data row or value if applicable – R4y  
Specify elevation in meters – R4y  
Provide data in SI units, derived units (such as degree Celsius), or non-SI units accepted for use with SI (such as minute, hour, day, mixing ratio data) – R3y  
Provide date/time in UTC or GMT, following ISO 8601 standard – R5y  
If time is specified in seconds past some starting point (e.g., midnight) and measurements in the file span date boundaries, assure that time increases monotonically (>86400) and date does not change – R5-  
Structure data so that consecutive rows have monotonically increasing or unique time tag where applicable – R5-  
Represent years with four digits – R5y  
Provide start and stop timestamps for measurements in irregular intervals – R5-  
Indicate data above or below a limit of detection using a flag value – R6-  
Represent flags (missing data, etc.) so as not to be construed as data – R6y  
Provide a separate column for flag values that vary from point to point – R6-  
  • No labels