R/QC2c.R

In rivm-syso/KRWQCprotocol: Standardised test for Dutch Groundwater Monitoring Networks

#' QC2c. Controle veldwaarnemingen
#'
#' Controle op veldwaarnemingen in het veld tijdens de bemonstering
#'
#' Ga na of er bijzonderheden zijn waargenomen tijdens de bemonstering.
#' Indien er bijzonderheden zijn genoteerd door de veldwerker, ken het
#' concept oordeel twijfelachtig toe aan het monster.
#'        
#' @param dir directory waarin het  QC2c_veldwaarnemingen.csv bestand
#' staat 
#' @param d_metingen dataframe met metingen
#' @param verbose of tekstuele output uit script gewenst is (T) of niet (F). 
#' Staat standaard op F.
#'
#' @return het metingen bestand met attribute van test resultaten. In de kolom
#' `oordeel` blijkt of de locatie/monster 'onverdacht' of 'verdacht' is.
#'
#' @export
#'


QC2c <- function(dir, d_metingen, verbose = F) {
  
  # Deze controle wordt door de beheerders uitgevoerd en bijgehouden
  # Deze informatie is wel benodigd voor het QC status
  # met QC2c_create_file wordt de benodigde datatabel gegenereerd
  # welke door de beheerders ingevuld moet worden
  
  # CSV Tabel inlezen ingevuld door beheerders
  fname <- "QC2c_veldwaarnemingen.csv"
  if(!dir.exists(dir)) {
    stop("directory bestaat niet")
  }
  
  # check of bestanden aanwezig zijn
  if(!file.exists(file.path(dir, fname))) {
    stop("CSV bestand met controles veldwaarnemingen bestaat niet. Run eerst QC2c_create_file.")
  }
  
  # Laad CSV bestand in met put afdekkingen
  d <- read.csv(file.path(dir, fname))
  
  # Check datasets
  testKolommenMetingen(d_metingen)
  testKolommenQC2c(d)
  
  # Verwijder lege rijen met NA's
  d <- d %>%
    dplyr::mutate(iden = paste(putcode, filter, jaar, maand, dag, sep = "-")) %>%
    dplyr::filter_all(dplyr::all_vars(!is.na(.)))
  
  rapportageTekst <- paste("Er zijn in totaal", nrow(d), 
                           "bemonsterde putcodes waar bijzonderheden", 
                           "geconstateerd zijn.")
  
  # Als er afwijkende beschadigingen zijn, print deze
  if(verbose) {  
    if(nrow(d) > 0) {
      write.table(
        rapportageTekst,
        row.names = F, col.names = F)
      print(d %>% dplyr::select(putcode, bijzonderheden))
      
    } else {
      # als er geen beschadigingen/afwijking genoemd zijn 
      print("Er zijn geen bijzonderheden geconstateerd.")
    }
  }
  
  # voeg concept oordeel van afwijkende putten toe aan monsters op die locaties in betreffende meetronde
  resultaat_df <- d_metingen %>%
    dplyr::group_by(monsterid) %>%
    dplyr::mutate(iden = paste(putcode, filter, jaar, maand, dag, sep = "-")) %>%
    dplyr::mutate(oordeel = ifelse(iden %in% d$iden,
                                   "twijfelachtig", "onverdacht")) %>%
    dplyr::filter(oordeel != "onverdacht") %>%
    dplyr::left_join(., d %>% dplyr::select(iden, bijzonderheden), by = "iden") %>%
    dplyr::select(qcid, monsterid, jaar, maand, dag, putcode, filter,
                  bijzonderheden, oordeel)
  
  # voeg attribute met uitkomsten tests toe aan relevante dataset (d_metingen)
  twijfelachtig_id <- resultaat_df %>% 
    dplyr::filter(oordeel == "twijfelachtig") %>% 
    dplyr::distinct(qcid) %>%
    dplyr::pull(qcid)
  
  test <- "QC2c"
  
  d_metingen <- qcout_add_oordeel(obj = d_metingen,
                                  test = test,
                                  oordeel = "twijfelachtig",
                                  ids = twijfelachtig_id)
  d_metingen <- qcout_add_rapportage(obj = d_metingen,
                                     test = test,
                                     tekst = rapportageTekst)
  d_metingen <- qcout_add_resultaat(obj = d_metingen,
                                    test = test,
                                    resultaat = resultaat_df)
  
  # return beoordeelde putten in d_veld en beoordeelde monsters in d_metingen
  return(d_metingen)
}


#' QC2c_create_file. Maak bestand voor Controle QC2c
#'
#' Maak een csv bestand aan wat ingevuld moet worden voor de
#' handmatige controle van de representativiteit van de put en filter.
#'
#' @param dir directory waarin het bestand aangemaakt moet worden
#'
#' Deze functie maakt een csv bestand aan genaamd
#' 'QC2c_veldwaarnemingen.csv'. Dit bestand wordt aangemaakt in de
#' opgegeven directory. Als het bestand al bestaat dan wordt het niet
#' overschreven.
#'
#' Het aangemaakte bestand moet vervolgens met de hand ingevuld worden
#' met behulp van de informatie afkomstig van de beheerders /
#' veldmedewerkers.
#'
#' Als het bestand correct is ingevuld dan kan het verwerkt worden
#' met behulp van  [QC2c()]. Let op, [QC2c()] verwacht dezelfde
#' bestandsnaam, verander deze dus niet.
#'
#' @export
#'
#'

QC2c_create_file <- function(dir) {
  
  fname <- "QC2c_veldwaarnemingen.csv"
  
  if(!dir.exists(dir)) {
    stop("directory bestaat niet")
  }
  
  
  if(!file.exists(file.path(dir, fname))) {
    d <- data.frame(putcode = "", 
                    filter = "",
                    jaar = "",
                    maand = "",
                    dag = "",
                    bijzonderheden = "")
    write.csv(d, file.path(dir, fname))
  }
}



testKolommenQC2c <- function(d) {
  # test of verplichte kolommen aanwezig zijn voor CSV tabellen
  
  kolommen <- c("putcode", "filter", "jaar", "maand", "dag", "bijzonderheden")
  
  if(length(setdiff(kolommen, names(d))) > 0) {
    stop("kolommen ontbreken of worden niet herkend")
  }
}