R/dateFilter.R

In MarijnJABoer/HeavySetR: A Heavyset Workout analysis package for R

#' Filter the date column using an end date
#'
#' Easily filter dates in a Heavyset csv exported dataframe, using a maximum date. The function will filter `end_date` as equal to or greater than. The HeavySet exported dataframe should still have the date column named `Date`.
#'
#' @param df dataframe created from a HeavySet csv export
#' @param end_date a data in the form of 'yyyy-mm-dd'
#' @return data.frame
#'
#' @export
#' @importFrom dplyr filter
#' @examples
#' df <- simData(repeats = 5)
#' head(df, 1)
#' weeklater <- Sys.Date() + 7
#' head(endDateFilter(df, weeklater), 1)
endDateFilter <- function(df, end_date) {
  df.filtered <- df %>% filter(date <= as.Date(end_date))
  return(df.filtered)
}

#' Filter the date column using a minimum date
#'
#' Easily filter dates in a Heavyset csv exported dataframe, using a minimum date. The function will filter `start_date` as equal to or greater than. The HeavySet exported dataframe should still have the date column named `Date`.
#'
#' @param df dataframe created from a HeavySet csv export
#' @param start_date a data in the form of 'yyyy-mm-dd'
#' @return data.frame
#' @export
#' @importFrom dplyr filter
#' @examples
#' df <- simData(repeats = 5)
#' head(df, 1)
#' weekbefore <- Sys.Date() - 7
#' head(startDateFilter(df, weekbefore), 1)
startDateFilter <- function(df, start_date) {
  df.filtered <- df %>% filter(date >= as.Date(start_date))
  return(df.filtered)
}