R/apply_mutations.R

In TheoPannetier/comrad: R implementation of a Competitive Radiation model

#' Apply random mutations to a community
#'
#' The trait value of each individual in the input community is modified by a mutation sampled in a normal distribution
#' of mean `0` and standard deviation `mutation_sd`.
#'
#' @param traits_comm trait values of individuals in the community
#' @param mutation_sd numeric `>= 0`, the standard deviation of the normal
#' distribution from which mutations are drawn.
#'
#' @author Theo Pannetier
#' @export

apply_mutations <- function(
  traits_comm,
  mutation_sd = default_mutation_sd()
) {
  # Test arguments -------------------------------------------------------------
  comrad::testarg_num(mutation_sd)
  comrad::testarg_pos(mutation_sd)

  # Apply mutations ------------------------------------------------------------
  mutations <- stats::rnorm(length(traits_comm), 0, mutation_sd)
  traits_comm <- traits_comm + mutations

  # Test output --------------------------------------------------------------
  comrad::testarg_num(traits_comm)

  return(traits_comm)
}