5  Data Dictionary

Author

Zachary M. Smith

The data dictionary below describes data from the WQMA Oracle database and the WQMA Analytical Data Store (WQMA parquet files). To get this table in R, use:

data("columns_dictionary", package = "nexus")
Important

The data dictionary empowers data users to quickly become familiar with a data set. Although the table is simple, it is critical to operations that this table remain up-to-date, accurate, and easy to understand.

If you find any errors or do not find the documentation clear, please open a GitHub Issue and we can collectively work towards a solution.

The data dictionary is stored and maintained in the nexus package.

The dictionary provides:

  1. table_name: The name of the table in the WQMA Oracle Database where the column_name is stored.

  2. column_name: The name of the column in the data store of interest. The naming convention is the same between the WQMA Oracle Database and WQMA Analytical Data Store.

  3. definition: A description of what the column represents.

  4. examples: Provides examples of the data found in a column. If more than 20 unique values are represented in the column, then 20 example character strings will be provided. If 20 or less unique values are represented in the column, all 20 values are provided.