Skip to content
GitLab
Select Git revision
  • master default
Find file BlameHistoryPermalink
vgest_read_chrono.R 3.96 KiB
1 
#' Read Chrono.txt or PaChrono.txt
2 
#'
3 
#' @description
4 
#' Read the time series provided by VGEST for the forward calculation (Chrono.txt) and backward calculation (PaChrono.txt)
5 
#'
6 
#' @details
7 
#' The format of the file is has follow. Headers are in line 53 followed by the complete time series which is backward in time for PaChrono.txt. The columns and respected widths are:
8 
#' - Downstream date (10)
9 
#' - QXsous (22)
10 
#'
11 
#' For each lake, we next have:
12 
#' - Upstream date (14)
13 
#' - 25 columns of flow and storage data (22)
14 
#' - if `DistributionType %in% c(4,5)`, 1 extra column (22)
15 
#' - 5 columns of codes (6)
16 
#'
17 
#' And then at the end:
18 
#' - 7 columns of flow (22)
19 
#' - 3 columns of codes (8)
20 
#' - 1 extra column of code for `DistributionType==5` (8)
21 
#'
22 
#' The file is saved in RDS format for quicker reading the next time.
23 
#'
24 
#' @param x file to read with txt extension
25 
#' @param ... further arguments passed to or from other methods
26 
#'
27 
#' @return
28 
#' @export
29 
#' @rdname vgest_read_chrono
30 
#'
31 
vgest_read_chrono <- function(x, ...) {
32 
  UseMethod("vgest_read_chrono", x)
33 
}
34
35
36 
#'
37 
#' @param nLakes number of lakes in the file
38 
#' @param distributionType Distribution type. See [vgest_write_batch] details
39 
#' @return [data.frame] with the content of the file
40 
#' @export
41 
#' @rdname vgest_read_chrono
42 
#'
43 
vgest_read_chrono.default <- function(x, nLakes, distributionType, ...) {
44 
  # Reading cached file if exists
45 
  rdsFile <- paste0(sub('\\..[^\\.]*$', '', x), ".rds")
46 
  if(file.exists(rdsFile)) {
47 
    df <- readRDS(rdsFile)
48 
  } else {
49 
    # Widths
50 
    width1Lake <- c(14, rep(22, 25))
51 
    if(distributionType %in% c(4,5)) { width1Lake <- c(width1Lake, 22)}
52 
    width1Lake <- c(width1Lake, rep(6,5))
53 
    widths <- c(10, 22, rep(width1Lake, nLakes), rep(22,7), rep(8,3))
54 
    if(distributionType == 5) { widths <- c(widths, 8) }
55 
    # Headers
56 
    if(distributionType %in% c(4,5)) {
57 
      headLine <- 54
58 
    } else {
59 
      headLine <- 53
60 
    }
61
62
63 
    s <- readLines(x, n = headLine)[headLine]
64 
    headers = trimws(unlist(read.fwf(textConnection(s), widths = widths, as.is = TRUE), use.names = FALSE))
65 
    # Read file in fixed format
66 
    df <- read.fwf(
67 
      file = x,
68 
      col.names = headers,
69 
      widths = widths,
70 
      skip = headLine,
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
strip.white = TRUE ) df[,grep(pattern = "date", names(df))] <- lapply(df[,grep(pattern = "date", names(df))], as.Date, format = "%d/%m/%Y") df <- dplyr::arrange(df, date.aval) saveRDS(df, file = rdsFile) } class(df) <- c("Chrono", class(df)) return(df) } #' #' @param result.dir path for storing the result of vgest run. The result is stored in a subfolder named high or low (depending on \code{bFlood}) followed by the threshold #' @param distributionType Distribution type. See [vgest_write_batch] details #' @param backward boolean `TRUE` for reading "PaChrono.txt", `FALSE` for reading "Chrono.txt" #' #' @return A list with items named \[station\]_\[high/low\]_\[threshold\] containing [data.frame] with the content of each file #' @export #' @rdname vgest_read_chrono #' #' @examples #' \dontrun{ #' objective <- objectives[1,] #' distributionType <- 2 #' vgest_run_store(objective, #' 1, 1, "Q_NAT_1900-2009.txt", #' "01/01/1900", "31/12/2009", distributionType) #' lChrono <- vgest_read_chrono(objective, distributionType) #' } vgest_read_chrono.Objectives <- function(x, distributionType, result.dir = "database", backward = TRUE, ...) { if(backward) { fileName <- "PaChrono.txt" } else { fileName <- "Chrono.txt" } sLowHigh <- c("low", "high") objectivePaths <- file.path(result.dir, x$station, paste0(sLowHigh[x$flood + 1], "_", x$threshold)) l <- lapply(1:nrow(x), function(i) { cat("Treating folder", objectivePaths[i], "...\n") vgest_read_chrono.default( file.path(objectivePaths[i], fileName), nLakes = nrow(x[i, "lakes"][[1]]), distributionType = distributionType ) }) names(l) <- paste(x$station, sLowHigh[x$flood + 1], x$threshold, sep = "_") class(l) <- c("ListChrono", class(l)) return(l) }