R/vascr2-package.R

In JamesHucklesby/vascr: Process Biological Impedance Sensing Data

#' @keywords internal
#' @importFrom rlang .data
"_PACKAGE"

## usethis namespace: start
## usethis namespace: end
NULL

#' re-export magrittr pipe operator
#'
#' @importFrom dplyr %>%
#' @name %>%
#' @rdname re-exports
#' @return Various outputs, please see documentation for source package
#' @export
NULL

# Allow use of dot in pipelines
globalVariables(".")

#' re-export tribble
#'
#' @importFrom dplyr tribble
#' @name tribble
#' @rdname re-exports
#' @export
NULL

#' re-export glue
#'
#' @importFrom glue glue
#' @name glue
#' @rdname re-exports
#' @export
NULL

#' Vascr growth data
#'
#' A dataset containing the growth curves of hCMEC/D3 cell lines seeded at various densities. 
#' The variables are as follows:
#'
#' @format A tibble with 346370 rows and 9 variables:
#' \describe{
#'   \item{Time}{The time at which the measurement was taken (hours)}
#'   \item{Unit}{The unit the measurement was taken in}
#'   \item{Well}{The well in which the measurement was taken}
#'   \item{Value}{The value of the measurement taken}
#'   \item{Frequency}{The frequency at which data was collected}
#'   \item{Experiment}{Name of the experiment}
#'   \item{Instrument}{The instrument data was collected on}
#'   \item{SampleID}{The numerical ID of the sample}
#'   \item{Sample}{The name of the treatment applied to the dataset}
#' }
#' 
#' @source Hucklesby 2020
"growth.df"



#' Vascr growth data which is not resampled
#'
#' A dataset containing the growth curves of hCMEC/D3 cell lines seeded at various densities. 
#' This is a subset of 'growth.df', without the final stages of processing.
#'
#' @format A tibble with 346370 rows and 9 variables:
#' \describe{
#'   \item{Time}{The time at which the measurement was taken (hours)}
#'   \item{Unit}{The unit the measurement was taken in}
#'   \item{Well}{The well in which the measurement was taken}
#'   \item{Value}{The value of the measurement taken}
#'   \item{Frequency}{The frequency at which data was collected}
#'   \item{Experiment}{Name of the experiment}
#'   \item{Instrument}{The instrument data was collected on}
#'   \item{SampleID}{The numerical ID of the sample}
#'   \item{Sample}{The name of the treatment applied to the dataset}
#' }
#' 
#' @keywords internal
#' 
#' @source Hucklesby 2020
"growth_unresampled.df"

#' Vascr growth data which is not re sampled
#'
#' A dataset containing the growth curves of hCMEC/D3 cell lines seeded at various densities. 
#' This is a subset of 'growth.df', with only Rb data for faster processing.
#'
#' @format A tibble with 346370 rows and 9 variables:
#' \describe{
#'   \item{Time}{The time at which the measurement was taken (hours)}
#'   \item{Unit}{The unit the measurement was taken in}
#'   \item{Well}{The well in which the measurement was taken}
#'   \item{Value}{The value of the measurement taken}
#'   \item{Frequency}{The frequency at which data was collected}
#'   \item{Experiment}{Name of the experiment}
#'   \item{Instrument}{The instrument data was collected on}
#'   \item{SampleID}{The numerical ID of the sample}
#'   \item{Sample}{The name of the treatment applied to the dataset}
#' }
#' 
#' @keywords internal
#' 
#' @source Hucklesby 2020
"rbgrowth.df"


#' Memoise a function to allow caching
#'
#' @param function_name the function to memoise
#' @param duration duration for the cache to last, default 10 days
#' @param omit_args arguments not to include in cache generation
#'
#' @importFrom memoise memoise
#'
#' @return a cached version fo a vascr function
#' 
#' @noRd
cache_function <- function(function_name, duration = 864000, omit_args = c()) {
  fn <- get(function_name, envir = rlang::ns_env("vascr"))
  fn <- memoise::memoise(
    fn
  )
  assign(function_name, fn, envir = rlang::ns_env("vascr"))
  return(invisible(TRUE))
}

.onLoad <- function(libname, pkgname) {
  lapply(c("ecis_import_raw", "ecis_import_model"), cache_function)
}