R/binomdm.R

In TJMurphy/mcpwr: foo

#' DataMaker for data following the binomial distribution
#'
#' @param k number of groups that you have tested
#' @param groupnames vector of names for the groups that you tested; make sure they are in order
#' @param n sample size for each of the groups
#' @param size the number of successes per group
#' @param prob probability of success for each group
#' @param plot TRUE or FALSE, to generate jitterplot
#'
#' @return a list of the input parameters and simulated data
#' @export
#'
#' @examples
#' binomdm(k = 3 , groupnames = c("control", "treatment1", "treatment2")
#' , n = c(40, 55, 55), size = c(5, 20, 20), prob = c(0.2, 0.2, 0.2), plot = TRUE)
#'
#'
binomdm <- function(k,groupnames, n, size, prob, plot){

  if(length(n) != k
     | length(size) != k
     | length(prob) != k
     | length(groupnames) != k)
  {
    print("STOP! Length of one of the variables (n, size, prob) does not match k")
    stop()
  }
  parameters <- list(groupnames = groupnames
                      , n = n
                      , size = size
                      , prob = prob)

  value_list <- lapply(1:k
                       , FUN = function(b){
                         stats::rbinom(n=n[b]
                                       , size = size[b]
                                       , prob = prob[b])
                       }
  )

  data <- as.data.frame(t(
    purrr::map_dfr(.x = value_list
                   , .f = ~ as.data.frame(t(.)))
  ))
  colnames(data) <- groupnames

  datap <- stats::na.omit(tidyr::pivot_longer(data = data
                                              , cols = everything()
                                              , names_to = "group"
                                              , values_to = "successes"))


  if(plot == T)
    {
      print(ggplot2::ggplot(datap,
                           ggplot2::aes(x= group
                                        , y = successes
                                        , color=group))
            + ggplot2::geom_jitter()
            + ggplot2::theme_bw()
      )
     }


  print(list(parameters, data))
  return(pielou)
}