R/random_sq.R

In michbur/tidysq: Tidy Processing and Analysis of Biological Sequences

#' Generate random sequences
#'
#' @templateVar alph_null_ok FALSE
#' 
#' @description Generates an \code{\link[=sq-class]{sq}} object with specified
#' number of sequences of given length and alphabet.
#' 
#' @param n [\code{integer(1)}]\cr
#'  A number of sequences to generate - must be non-negative.
#' @param len [\code{integer(1)}]\cr
#'  Length of each sequence if \code{sd} not specified and mean length of
#'  sequences if \code{sd} specified - must be non-negative.
#' @template alphabet
#' @param sd [\code{integer(1)}]\cr
#'  If specified, gives standard deviation of length of generated sequences -
#'  must be non-negative.
#' @param use_gap [\code{logical(1)}]\cr
#'  If \code{TRUE}, sequences will be generated with random gaps inside
#'  (commonly denoted as "\code{-}").
#'
#' @return An object of class \code{sq} with type as specified.
#'
#' @details
#' Letter '*' is not used in generating \strong{ami} sequences. If parameter
#' \code{sd} is passed, then all generated negative values are replaced with 0s.
#'
#' @examples
#' # Setting seed for reproducibility
#' set.seed(16)
#'
#' # Generating random sequences
#' random_sq(10, 10, "ami_bsc")
#' random_sq(25, 18, "rna_bsc", sd = 6)
#' random_sq(50, 8, "dna_ext", sd = 3)
#' random_sq(6, 100, "ami_bsc", use_gap = TRUE)
#'
#' # Passing whole alphabet instead of type
#' random_sq(4, 12, c("Pro", "Gly", "Ala", "Met", "Cys"))
#'
#' # Generating empty sequences (why would anyone though)
#' random_sq(8, 0, "rna_ext")
#'
#' @family input_functions
#' @export
random_sq <- function(n, len, alphabet, sd = NULL, use_gap = FALSE) {
  assert_count(n)
  assert_count(len)
  assert_character(alphabet, any.missing = FALSE, min.len = 0, unique = TRUE, null.ok = TRUE)
  assert_number(sd, null.ok = TRUE)
  assert_flag(use_gap)
  
  if (length(alphabet) == 1) {
    type <- interpret_type(alphabet)
    if (type == "unt")
      stop("method 'random_sq' cannot take 'unt' as alphabet type", call. = FALSE)
    else
      alphabet <- CPP_get_standard_alphabet(type)
  } else {
    alphabet <- sq_alphabet(alphabet, "atp")
  }
  
  if (!is.null(sd)) {
    # TODO: issue #55
    len <- round(rnorm(n, len, sd))
    len <- ifelse(len < 0, 0, len)
  }
  
  CPP_random_sq(n, len, alphabet, use_gap)
}