Metadata

The metadata for the Rotoiti project is within the rotoiti_data_qc.zip folder. This folder contains the metadata for the project, including the device position, device variable, quality control filters, sensor calibrations, sensor reference, sensor scaling, site devices, site events, sites and variables.

In this document, we will describe the contents of each file in the rotoiti_data_qc.zip folder. The files are in CSV format.

Load libraries

library(dplyr)
library(readr)
library(DT)

# Set timezone to NZST
withr::local_locale(c("LC_TIME" = "C"))
withr::local_timezone("Etc/GMT-12")

1 Download data from GitHub

piggyback::pb_download(
  file = "rotoiti_data_qc.zip",
  dest = ".",
  repo = "limnotrack/f_rotoiti",
  tag = "v0.0.1"
)

# Unzip the file
unzip("rotoiti_data_qc.zip")
list.files("rotoiti_data_qc", recursive = TRUE)
 [1] "device_position.csv"     "device_variable.csv"    
 [3] "qc_filters.csv"          "qc_update_table.csv"    
 [5] "README.txt"              "rotoiti_qc.csv"         
 [7] "sensor_calibrations.csv" "sensor_reference.csv"   
 [9] "sensor_scaling.csv"      "site_devices.csv"       
[11] "site_events.csv"         "sites.csv"              
[13] "variables.csv"

2 Files

2.1 Device position

The device position is stored in a CSV file. The file contains the following columns:

  • device_id: The unique identifier for the device.

  • reference: The location of the device. This can be depth (“d”), height (“h”) or elevation (“e”).

  • z_relative: The relative position of the device in meters. This is the distance from the reference point to the device.

device_position <- read_csv("rotoiti_data_qc/device_position.csv", col_types = cols())
device_position
Table 1: Device position and relative distance.

2.2 Device variable

The device variable is stored in a CSV file. The file contains the following columns:

  • device_id: The unique identifier for the device.

  • var_abbr: The variable abbreviation. This is the short name for the variable.

device_variable <- read_csv("rotoiti_data_qc/device_variable.csv", col_types = cols())
device_variable
Table 2: Device variable mapping.

2.3 Quality control filters

The quality control filters are stored in a CSV file. The file contains the following columns:

  • var_abbr: The variable abbreviation. This is the short name for the variable.

  • low: The lower limit for the variable. This is the minimum value for the variable.

  • high: The upper limit for the variable. This is the maximum value for the variable.

  • roc: The rate of change for the variable. This is the maximum rate of change for the variable.

  • consec: The consecutive number of points for the variable. This is the minimum number of consecutive points for the variable.

  • interp: The interpolation for the variable. This is the maximum number of points for the variable.

qc_filters <- read_csv("rotoiti_data_qc/qc_filters.csv", col_types = cols())

qc_filters
Table 3: Quality control filters.

2.4 Quality controlled data

This is the finished quality controlled data. There is a summary of this data on the Quality control page.

2.5 Sensor calibrations

The sensor calibrations are stored in a CSV file. The file contains the following columns: - device_id: The unique identifier for the device. - date: The date of the calibration. - site: The site of the calibration. - variable: The variable of the calibration. - temperature: The temperature of the calibration. - type: The type of calibration. - comment: The comment for the calibration.

sensor_calibrations <- read_csv("rotoiti_data_qc/sensor_calibrations.csv", col_types = cols())

sensor_calibrations
Table 4: Sensor calibrations.

2.6 Sensor reference

The sensor reference is stored in a CSV file. The file contains the following columns:

  • device_id: The unique identifier for the device.

  • date: The date of the reference measurement.

  • reference_type: The type of reference measurement.

  • value_actual: The actual value of the reference measurement.

  • units_value: The units of the actual value.

  • value_measured: The measured value of the reference measurement.

  • units_sensor: The units of the measured value.

  • temperature: The temperature of the reference measurement.

  • comment: The comment for the reference measurement.

sensor_reference <- read_csv("rotoiti_data_qc/sensor_reference.csv", col_types = cols())

sensor_reference
Table 5: Sensor reference measurements.

2.7 Sensor scaling

The sensor scaling is stored in a CSV file. The file contains the following columns:

  • device_id: The unique identifier for the device.

  • date: The date of the scaling.

  • offset: The offset for the scaling.

  • multiplier: The multiplier for the scaling.

  • range: The range for the scaling.

  • log_multiplier: The logger multiplier for the scaling.

  • source: The source of the scaling factors.

  • comment: The comment for the scaling.

sensor_scaling <- read_csv("rotoiti_data_qc/sensor_scaling.csv", col_types = cols())

sensor_scaling
Table 6: Sensor scaling relationships.

2.8 Site devices

The site devices are stored in a CSV file. The file contains the following columns:

  • site: The site of the device.

  • device_id: The unique identifier for the device.

  • date_from: The date the device was installed.

  • date_to: The date the device was removed.

  • notes_device: The notes for the device.

  • notes: The notes for the site.

site_devices <- read_csv("rotoiti_data_qc/site_devices.csv", col_types = cols())

site_devices
Table 7: Site devices.

2.9 Site events

The site events are stored in a CSV file. The file contains the following columns:

  • site: The site of the event.

  • date: The date of the event.

  • site_visit: Was the site visited?

  • variables: The variables of the event.

  • action: The action of the event. Can be “deployed”, “removed”, “cleaned”, “rebooted” or “other”.

  • comment: The comment for the event.

site_events <- read_csv("rotoiti_data_qc/site_events.csv", col_types = cols())

site_events
Table 8: Site events.

2.10 Sites

The sites are stored in a CSV file. The file contains the following columns:

  • site: The site of the device.

  • location: The location of the site.

  • type: The type of site. Can be “lake”, “river” or “other”.

  • customer: The customer of the site.

  • lon: The longitude of the site.

  • lat: The latitude of the site.

  • elev: The elevation of the site.

sites <- read_csv("rotoiti_data_qc/sites.csv", col_types = cols())

sites
Table 9: Sites.

2.11 Variables

The variables are stored in a CSV file. The file contains the following columns:

  • var_abbr: The variable abbreviation. This is the short name for the variable.
  • full_text: The full text of the variable. This is the long name for the variable.
  • parsed: The parsed name of the variable. This is the name used for plotting.
  • label: The label of the variable. This is the name used for the legend.
variables <- read_csv("rotoiti_data_qc/variables.csv", col_types = cols())

variables
Table 10: Variables.