R/init_pir_params.R

Defines functions init_pir_params

Documented in init_pir_params

#' Initialize the \code{pir_params}.
#'
#' A normal user should never need to call this function.
#' @seealso Use \link{check_init_pir_params} to check
#'   if a \code{pir_params} is initialized
#' @inheritParams default_params_doc
#' @return a `pir_params`
#' @export
init_pir_params <- function(pir_params) {

  for (i in seq_along(pir_params$experiments)) {
    pir_params$experiments[[i]] <- pirouette::init_experiment(
      experiment = pir_params$experiments[[i]],
      alignment_params = pir_params$alignment_params
    )
  }
  pir_params
}
richelbilderbeek/pirouette documentation built on Oct. 18, 2023, 3:09 p.m.