R/iqr_glu.R

In irinagain/iglu: Interpreting Glucose Data from Continuous Glucose Monitors

#' Calculate glucose level iqr
#'
#' @description The function iqr_glu outputs the distance between the 25th
#' percentile and the 25th percentile of the glucose values in a tibble object.
#'
#' @usage
#' iqr_glu(data)
#'
#' @param data DataFrame object with column names "id", "time", and "gl",
#' or numeric vector of glucose values.
#'
#' @details
#' A tibble object with 1 row for each subject, a column for subject id and
#' a column for the IQR values is returned. NA glucose values are
#' omitted from the calculation of the IQR.
#'
#' @return If a data.frame object is passed, then a tibble object with
#' two columns: subject id and corresponding IQR value is returned. If a vector of glucose
#' values is passed, then a tibble object with just the IQR value is returned.
#' as.numeric() can be wrapped around the latter to output just a numeric value.
#'
#' @export
#'
#' @examples
#' data(example_data_1_subject)
#' iqr_glu(example_data_1_subject)
#'
#' data(example_data_5_subject)
#' iqr_glu(example_data_5_subject)
#'

iqr_glu <- function(data){

  gl = id = NULL
  rm(list = c("gl", "id"))
  data = check_data_columns(data)
  is_vector = attr(data, "is_vector")

  out = data %>%
    dplyr::group_by(id) %>%
    dplyr::summarise(
      IQR = IQR(gl, na.rm = TRUE)
    )
  if (is_vector) {
    out$id = NULL
  }
  return(out)
}