In C3S-Data-Rescue-Lot1-WP3/C3S-QC: C3S quality control tools for historical climate data

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)

Introduction

The software dataresqc is a R package that contains several quality control and formatting tools for rescued climate data from land stations.

Version 1.0.0 was released in December 2019 and can be installed from any CRAN mirror with the command

install.packages("dataresqc")

or from GitHub (https://github.com/c3s-data-rescue-service/dataresqc) with

devtools::install_github("c3s-data-rescue-service/dataresqc")

Note that the latter requires the package devtools.

System requirements

dataresqc requires R version 3.2 or higher and was built under version 3.6.2.

Some graphical functions require the additional package ggplot2.

Functions

The package provides 25 functions. Each function is documented using the roxygen2 package and the documentation of a specific function can be called with the command ?function_name; a PDF file containing the documentation of all functions is available at https://github.com/c3s-data-rescue-service/dataresqc/raw/master/docs/dataresqc_1.0.0.pdf.

The code for the functions is organized in 9 files (folder R):

library(knitr)
x <- data.frame(File=list.files("../R"), Content=c("Quality control functions developed at the University Rovira i Virgili", "Conversion functions", "Documentation of data used for examples", "Graphical functions developed at the University of Bern", "Quality control functions developed at the University of Lisbon", "Functions to read SEF files and check compliance with SEF documentation", "Functions to write SEF files and quality flags", "Wrapper of all quality control functions", "Quality control functions developed at the University of Bern"), stringsAsFactors=FALSE)
kable(x)

Built-in data

The documentation of each function includes a working example. The data used in the examples is stored as .rda files in the folder data. These files were generated from the raw data stored in the folder data-raw using the script data-raw/load_data.R (only available on GitHub).

User documentation

The following documentation is provided to the user:

• Built-in function documentation (generated with roxygen2, see above);
• Wiki (generated on GitHub using Markdown language; available in HTML at https://github.com/c3s-data-rescue-service/dataresqc/wiki and as PDF file on the portal);
• Tutorial (generated with knitr using R Markdown language; available in HTML at https://c3s-data-rescue-service.github.io/dataresqc/index.html and as PDF file on the portal);
• additional guidance is provided in the Best Practice Guidelines on Formatting, Metadata, and QC.

The PDF wiki is automatically syncronized with the HTML version by...

The .Rmd file for the tutorial is stored in the vignette folder on GitHub, along with the images used in the tutorial.

License

The license that was chosen for the software is Apache 2.0 (http://www.apache.org/licenses/LICENSE-2.0), following recommendations from the CDS staff.

Future developments

This document is for dataresqc version 1.0.0. Additional functions may be added in the future depending on users feedback. The formatting functions will be kept in sync with the developments of the Station Exchange Format.

C3S-Data-Rescue-Lot1-WP3/C3S-QC documentation built on Jan. 15, 2020, 10:36 p.m.