R/MVgen.R

Defines functions MVgen

Documented in MVgen

#' @title Amputation of a dataset
#' 
#' @description This function is designed to ampute datasets.
#' 
#' @param dataset dataset to be amputed
#' @param prop_NA desired proportion of missing values in the amputed dataset
#'
#' @return A dataset with missing values.
#' @references M. Chion, Ch. Carapito and F. Bertrand (2021). \emph{Accounting for multiple imputation-induced variability for differential analysis in mass spectrometry-based label-free quantitative proteomics}. \doi{doi:10.1371/journal.pcbi.1010420}.
#' @export
#'
#' @examples
#' library(mi4p)
#' data(datasim)
#' datasim_amp <- MVgen(datasim, .2)
#' sum(is.na(datasim_amp))/prod(dim(datasim_amp))
MVgen <- function(dataset, prop_NA){
  data_NA <- dataset
  n_NA <- prop_NA * prod(dim(dataset))
  row_NA <- sample(1:nrow(dataset), n_NA, replace = TRUE)
  col_NA <- sample(1:ncol(dataset), n_NA, replace = TRUE)
  for (i in 1:n_NA) data_NA[row_NA[i], col_NA[i]] <- NA
  return(data_NA)
}
mariechion/mi4p documentation built on Oct. 3, 2024, 4:50 a.m.