R/report_net_diagnostic.R

In bcgov/hydrolook: Hydrometric Network Diagnostic

# Copyright 2017 Province of British Columbia
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and limitations under the License.


#' @export
#'
#' @title Generate diagnostic report
#'
#' @param PROV_TERR_STATE_LOC Province to be surveyed. Defaults to BC.
#' @param output_type the type of file to be outputted. Currently html and pdf are supported. defaults to pdf
#'
#' @description run this command to render the net_diag report. The reports are then outputted to the report folder
#' @family report_generators
#' @examples
#' \dontrun{
#' report_net_diagnostic(output_type = "pdf", PROV_TERR_STATE_LOC = "PE")
#' }


report_net_diagnostic <- function(output_type = "pdf", PROV_TERR_STATE_LOC = "BC") {

  if(!output_type %in% c("pdf","html")){
    stop('output_type must be "pdf" or "html"')
  }

  input_path = system.file("templates", "net_diag.Rmd", package="hydrolook")

  check_report_packages(input_path)

  dir_here <- file.path("report/net_diag")

  if(!dir.exists(dir_here)){
    dir.create(dir_here, recursive = TRUE)
  }

  ## Keep a record water office status
  stns <- tidyhydat::realtime_stations(prov_terr_state_loc = "BC")
  stns_split <- split(stns$STATION_NUMBER, (seq(length(stns$STATION_NUMBER))) %/% 20)
  wo_status <- purrr::map_dfr(stns_split, ~ check_water_office_status(.x))
  wo_status$Date <- Sys.time()


  if(file.exists(file.path("report/net_diag", "water_office_record.csv"))){
    path_to_write <- file.path("report/net_diag", "water_office_record.csv")
    existing_wo_status <- readr::read_csv(path_to_write)
    wo_status <- dplyr::bind_rows(existing_wo_status, wo_status)
    readr::write_csv(wo_status, path_to_write)
    message(paste0("Appending data collected at ", Sys.time(), " to ", path_to_write))
  }


  if(!file.exists(file.path("report/net_diag", "water_office_record.csv"))){
    ans <- ask(paste0("hydrolook would like to create '", suppressWarnings(normalizePath("report/net_diag/water_office_record.csv")),
                      "' Is that okay?"))
    if(ans == TRUE){
      path_to_write <- file.path("report/net_diag", "water_office_record.csv")
      readr::write_csv(wo_status, path_to_write)
      message(paste0("Creating ", path_to_write))
    }

    if (!ans) {
      warning("A record of station status will not be created", call. = FALSE)
    }

  }




  ## Render report
  rmarkdown::render(input = input_path,
                    output_format = paste0(output_type,"_document"),
                    intermediates_dir = dir_here,
                    params = list(
                      table_format = ifelse(output_type == "pdf","latex","html"),
                      prov = PROV_TERR_STATE_LOC
                    ),
                    output_file = paste0("net_diag_",PROV_TERR_STATE_LOC,"_",Sys.Date(),".",output_type),
                    output_dir = dir_here)





}