R/qpcr_avg_techrep.R

In JorikBot/tidyqpcr: Function for tidy ddCt qPCR analysis

#' Average technical replicates
#'
#' This function calculates the average of every technical replicate.
#' \code{mean} function argument na.rm is set to TRUE by default.
#'
#' @param .data A data frame or tibble.
#' @param cq Unquoted expression. The name of the column containing the Cq
#'   values.
#' @param ... Tidy-select. One or more unquoted expressions separated by commas.
#'   All the names of columns that denote your experimental variables (and
#'   biological replicates). The average will be taken for every unique
#'   combination of values in the supplied columns. Be sure to exclude the
#'   columns containing the Cq values or technical replicates.
#'
#' @return Returns the same type as the input (e.g. a data frame or tibble). All
#'   columns supplied in ... will be returned. Creates a new column for the
#'   averaged Cq values with the name "cq".
#' @export
#'
#' @examples
#' avg_data <- qpcr_avg_techrep(ex_clean,
#'                              cq = cq_values,
#'                              treatment, primer_pair, bio_rep)
qpcr_avg_techrep <- function(.data, cq, ...) {
  .data %>%
    dplyr::group_by(...) %>%
    dplyr::summarise(cq = base::mean({{ cq }}, na.rm = TRUE)) %>%
    dplyr::ungroup()
}