format.R 7.99 KiB
# \\\
# Copyright 2021-2022 Louis Héraut*1
# *1   INRAE, France
#      louis.heraut@inrae.fr
# This file is part of ash R toolbox.
# ash R toolbox is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or (at
# your option) any later version.
# ash R toolbox is distributed in the hope that it will be useful, but 
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with ash R toolbox.  If not, see <https://www.gnu.org/licenses/>.
# ///
# processing/format.R
# Manages all the format problem of data and info. Mainly problem of
# input and output of the 'StatsAnalysisTrend' package. It also allows
# to join different selections of station and to gets exact period of
# trend analysis.
# Usefull library
library(dplyr)
## 1. INPUT
### 1.1. Preparation
# Prepares the data in order to have a list of a data tibble with
# date, group and flow column and a info tibble with the station code
# and group column to fit the entry of the 'extract.Var' function in
# the 'StatsAnalysisTrend' package
prepare = function(df_data, colnamegroup=NULL) {
    # Forces the column name to group to be a vector 
    colnamegroup = c(colnamegroup)
    # Converts it to index of the column to group
    colindgroup = which(colnames(df_data) == colnamegroup)
    # Groups the data by those indexes
    df_data = group_by_at(df_data, colindgroup)
    # Creates a new tibble of data with a group column
    data = tibble(Date=df_data$Date, 
                  group=group_indices(df_data),
                  Qm3s=df_data$Qm3s)
    # Gets the different value of the group
    Gkey = group_keys(df_data)
    # Creates a new tibble of info of the group
    info = bind_cols(group=seq(1:nrow(Gkey)),
                     Gkey)
    # Stores data and info tibble as a list that match the entry of
    # the 'extract.Var' function
    res = list(data=data, info=info)
    return (res)
### 1.2. Re-preparation
# Re-prepares the data in outing of the 'extract.Var' function in
# the 'StatsAnalysisTrend' package in order to fit again to the
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
# entry of the same function reprepare = function(df_XEx, df_Xlist, colnamegroup=NULL) { # Changes the column name of the results of the # 'extract.Var' function colnames(df_XEx) = c('Date', 'group', 'Qm3s') # Converts Date column as character df_XEx$Date = as.character(df_XEx$Date) # Takes the first date as example exDate = df_XEx$Date[1] # Finds the number of dash in the date nbt = lengths(regmatches(exDate, gregexpr('-', exDate))) # If there is only one dash if (nbt == 1) { # Converts it to date from a year and a month df_XEx$Date = paste(df_XEx$Date, '01', sep='-') # If there is no dash } else if (nbt == 0) { # Converts it to date from only a year df_XEx$Date = paste(df_XEx$Date, '01', '01', sep='-') # If there is more than 2 dashes } else if (nbt != 2) { # This is not a classical date stop('erreur of date format') } # Recreates the outing of the 'extract.Var' function nicer df_XEx = bind_cols(Date=as.Date(df_XEx$Date, format="%Y-%m-%d"), df_XEx[-1], df_Xlist$info[df_XEx$group, 2:ncol(df_Xlist$info)]) # Prepares the nicer outing df_XlistEx = prepare(df_XEx, colnamegroup=colnamegroup) return (df_XlistEx) } ## 2. OUTPUT # Cleans the trend results of the function 'Estimate.stats' in the # 'StatsAnalysisTrend' package. It adds the station code and the # intercept of the trend to the trend results. Also makes the data # more presentable. clean = function (df_Xtrend, df_XEx, df_Xlist) { # Reprepares the list of data and info in order to be presentable df_Xlist = reprepare(df_XEx, df_Xlist, colnamegroup=c('code')) # Adds a column of station code df_Xlist$data$code = NA # For all the group for (g in df_Xlist$info$group) { # Adds the station code corresponding to each group info df_Xlist$data$code[which(df_Xlist$data$group == g)] = df_Xlist$info$code[df_Xlist$info$group == g] } # Adds the info to trend tibble df_Xtrend = bind_cols(df_Xtrend, df_Xlist$info[df_Xtrend$group1, 2:ncol(df_Xlist$info)]) # Renames the column of group of trend results colnames(df_Xtrend)[1] = 'group' # Adds the intercept value of trend df_Xtrend = get_intercept(df_Xtrend, df_Xlist, unit2day=365.25) # Changes the position of the intercept column df_Xtrend = relocate(df_Xtrend, intercept, .after=trend) # Creates a list of results to return res = list(trend=df_Xtrend, data=df_Xlist$data, info=df_Xlist$info)