R/SimSwissRoll.R

In feji3769/simplesim: Simulate Data for Model Building

#' @title Simulate a Swiss Roll in 3d
#' @description Simulate data from a Swiss Roll. 
#' @param N number of data points to simulate.
#' @param sigma noise level.
#' @param seed seed for RNG (default = NULL).
#' @return list(data = matrix(x,y,z), t = t)
#' @export
#' @examples
#' N = 100
#' noise = .1
#' SimSwissRoll(N, noise)
SimSwissRoll = function(N, sigma, seed = NULL){
  if(!is.null(seed)){
    .checkSeed(seed)
    set.seed(seed)
  }
  if(!is.null(seed)){
    .checkSeed(seed)
  } else {
    seed = -1
  }
  if(!is.numeric(N)){
    stop("N must be a number.")
  }
  if(!is.numeric(sigma)){
    stop("sigma must be a number.")
  }
  if(sigma < 0){
    stop("Sigma must be greater than zero.")
  }
  if(N < 0){
    stop("N must be greater than zero.")
  }
  if(floor(N) != N){
    stop("N must be a whole number.")
  }
  result = SimSwissRollC(N, sigma)
  return(result)
}