R/creer_variable_Mois.R

In PascalIrz/ondetools: Package R pour traiter les données ONDE de suivi des étiages en France

#' Création de la variable Mois
#'
#' Création de la variable Mois en 2 caractères alphanumériques (01 à 12). Ce format est plus pratique pour les
#'     graphiques ultérieurs qui nécessitent une variable catégorielle mais ordonnée.

#'
#' @param onde_df Le dataframe contenant les données ONDE, mis en forme en format "long".
#'
#' @return Le dataframe contenant les données ONDE, mis en forme en format "long", auquel a été ajoutée
#'     une variable caractère "Mois" codée de "01" à "12".
#' @export
#' @importFrom dplyr mutate
#' @importFrom lubridate ymd
#' @importFrom stringr str_pad
#'
#' @examples \dontrun{
#' stations_onde_geo <- stations_onde_geo %>%
#'     creer_variable_Mois()
#' }
creer_variable_Mois <- function(onde_df) {

  onde_df <- onde_df %>%
    mutate(Mois = lubridate::ymd(DtRealObservation) %>%
             lubridate::month() %>%
             str_pad(width = 2, side = "left", pad = "0")) %>%
    filter(TRUE)

}