Rewrote vignette

Author: EdwinTh

NAMESPACE

@@ -1,4 +1,10 @@
 # Generated by roxygen2: do not edit by hand
 
+export(fill_by_function)
+export(fill_by_prevalent)
+export(fill_by_value)
+export(get_interval)
+export(pad)
+export(thicken)
 importFrom(Rcpp,sourceCpp)
 useDynLib(padr)

R/fill_functions.R

@@ -18,7 +18,7 @@
 #' x_padded <- x_df %>% pad
 #' x_padded %>% fill_by_value(y1)
 #' x_df %>% pad %>% fill_by_value(y1, y2, value = 42)
-
+#' @export
 fill_by_value <- function(x,
                           ...,
                           value = 0) {
@@ -59,6 +59,7 @@ fill_by_value <- function(x,
 #'                    y2 = runif(200, 1, 50) %>% round)
 #' x_df %>% pad %>% fill_by_function(y1, y2)
 #' x_df %>% pad %>% fill_by_function(y1, y2, fun = median)
+#' @export
 fill_by_function <- function(x,
                              ...,
                              fun = mean) {
@@ -108,7 +109,7 @@ fill_by_function <- function(x,
 #'                   y1 = rep(letters[1:3], c(80, 70, 50)) %>% sample,
 #'                   y2 = rep(letters[2:5], c(60, 80, 40, 20)) %>% sample)
 #' x_df %>% pad %>% fill_by_prevalent(y1, y2)
-
+#' @export
 fill_by_prevalent <- function(x,
                               ...) {
 

R/pad.R

@@ -52,7 +52,7 @@
 #'
 #' x_df_grp %>% group_by(grp) %>% do(pad(.)) %>% ungroup %>%
 #' tidyr::fill(grp)
-
+#' @export
 pad <- function(x,
                 interval = NULL,
                 start_val= NULL,
@@ -82,23 +82,47 @@ pad <- function(x,
     warning('Datetime variable was unsorted, pad result is sorted.')
   }
 
+  int_hierarchy <- 1:8
+  names(int_hierarchy) <- c('year','quarter', 'month', 'week', 'day', 'hour','min', 'sec')
+
   if(is.null(interval)) {
     interval <- get_interval(dt_var)
   } else {
 
     interval_dt_var <- get_interval(dt_var)
 
-    int_hierarchy <- 1:8
-    names(int_hierarchy) <- c('year','quarter', 'month', 'week', 'day', 'hour','min', 'sec')
-
     if(int_hierarchy[interval_dt_var] > int_hierarchy[interval]) {
       stop('The interval of the datetime variable is higher than the interval given,
             if you wish to pad at this interval you should thicken and aggregate first.')
     }
   }
 
-  if(is.Date(dt_var) & int_hierarchy[interval] > 5) {
+  # Proper handling of switching between Date and POSIX
+  if(class(dt_var) == 'Date' & int_hierarchy[interval] > 5) {
      dt_var <- as.POSIXct(as.character(dt_var))
+     pos    <- which(colnames(original_data_frame) == dt_var_name)
+     original_data_frame[ ,pos] <- dt_var
+  }
+
+  if('Date' %in% class(dt_var) & ('POSIXt' %in% class(start_val) |
+                                'POSIXt' %in% class(end_val))) {
+    dt_var <- as.POSIXct(as.character(dt_var))
+    pos    <- which(colnames(original_data_frame) == dt_var_name)
+    original_data_frame[ ,pos] <- dt_var
+  }
+
+  if('POSIXt' %in% class(dt_var) & ('Date' %in% class(start_val) |
+                                     'Date' %in% class(end_val))){
+    stop('start_val and/or end_val should be of class POSIXt when the input variable is as well')
+  }
+
+  # Throw an error when start_val and / or end_val are not in sync with the interval
+  all_elements <- list(start_val, dt_var, end_val)
+  all_non_null <- all_elements[sapply(all_elements, function(x) !is.null(x))]
+  all_non_null <- do.call('c', all_non_null)
+  necesarry_interval <- get_interval(all_non_null)
+  if(int_hierarchy[necesarry_interval] > int_hierarchy[interval]) {
+    stop('start_val and/or end_val are invalid for the given combination of interval and the datetime variable')
   }
 
   spanned <- span_pad(dt_var, start_val, end_val, interval)

R/pad_helpers.R

@@ -9,11 +9,11 @@
 #' @examples
 #' x_month <- seq(as.Date('2016-01-01'), as.Date('2016-05-01'), by = 'month')
 #' get_interval(x_month)
-
+#' @export
 get_interval <- function(x) {
 
   if( !(c('Date', "POSIXt") %in% class(x) %>% any)) {
-    stop('x should be of class Date, POSIXct, or POSIXlt', call. = FALSE)
+    stop('x should be of class Date, POSIXct, or POSIXlt')
   }
 
   x_char <- strftime(x)
@@ -48,7 +48,7 @@ get_interval <- function(x) {
 
     } else if(lowest_level == 'day') {
       distances <- difftime(x[2:length(x)], x[1:(length(x)-1)], units = 'weeks')
-      weeks     <- all( ( as.numeric(distances) %% 1 ) == 1 )
+      weeks     <- all( ( as.numeric(distances) %% 1 ) == 0 )
       if(weeks) lowest_level <- 'week'
     }
     return(lowest_level)

R/thicken.R

@@ -48,7 +48,7 @@
 #' weekdays(min_x)
 #' x_df %>% thicken(start_val = min_x - 1) %>%
 #'   group_by(x_week) %>% summarise(y_avg = mean(y))
-
+#' @export
 thicken <- function(x,
                     interval = c('level_up',
                               'year',

R/thicken_helpers.R

@@ -51,8 +51,6 @@ round_down <- function(a,
   return(thickened[order_a])
 }
 
-
-#' @rdname span_year
 round_up <- function(a,
                      b) {