inst/artma/calc/dof.R

In artma: Automatic Replication Tools for Meta-Analysis

box::use(
  artma / libs / validation[assert]
)
#' Calculate degrees of freedom using a t-value and a PCC
#'
#' @note The t_value and PCC can be provided either as a single numeric value, or as vectors of the same length.
#'
#' @param t_value [numeric] The t-value(s) to use for the calculation.
#' @param pcc [numeric] The partial correlation coefficient(s) to use for the calculation.
#' `numeric` The calculated degrees of freedom.
#' @export
calculate_dof <- function(t_value, pcc) {
  assert(length(t_value) != length(pcc), "The length of 't_value' and 'pcc' must be the same.")

  # Q: Is it okay to drop all PCCs outside of the range (-1, 1)?
  lhs <- t_value^2
  rhs <- (1 / (pcc^2)) - 1
  return(lhs * rhs)
}