R/overall_average.R

In rpmartin/lmio: What the Package Does (One Line, Title Case)

#' @title FUNCTION_TITLE
#' @description FUNCTION_DESCRIPTION
#' @param a_tibble PARAM_DESCRIPTION
#' @param var PARAM_DESCRIPTION
#' @return OUTPUT_DESCRIPTION
#' @details DETAILS
#' @import dplyr
#' @examples 
#' \dontrun{
#' if(interactive()){
#'  #EXAMPLE1
#'  }
#' }
#' @rdname overall_average
#' @export
overall_average <- function(a_tibble,var){
  a_tibble%>%
    summarize(ave=mean({{  var  }}))%>%
    pull()
}