R/get_pkg_info.R

Defines functions get_conds get_sim_conds get_n_0s get_logliks get_param_names

Documented in get_conds get_logliks get_n_0s get_param_names get_sim_conds

#' @title Sim Conditionings
#' @author Giovanni Laudanno
#' @description Gives sim conditionings
#' @inheritParams default_params_doc
#' @return sim conditionings
#' @export
get_conds <- function() {
 conds <- c(as.numeric(sub(
  cond_functions(),
  pattern = "sim_cond_",
  replacement = ""
 )))
 conds
}

#' @title Conditioning functions
#' @description Conditioning functions
#' @author Giovanni Laudanno
#' @inheritParams default_params_doc
#' @return the conditional functions
#' @export
get_sim_conds <- function() {
 fun_list <- ls(paste0("package:", get_pkg_name())) # nolint internal function
 sim_conds <- fun_list[sapply(
  fun_list, function(x)
   any(grepl("sim_conds_", x))
 )]
 sim_conds
}

#' @title Starting species
#' @author Giovanni Laudanno
#' @description Gives the amount of starting species
#' @inheritParams default_params_doc
#' @return the possible n_0s
#' @export
get_n_0s <- function() {
 n_0s <- c(2)
 n_0s
}

#' @title Loglik functions
#' @author Giovanni Laudanno
#' @description Gives the available loglik functions
#' @inheritParams default_params_doc
#' @return the loglik function
#' @export
get_logliks <- function() {
 fun_list <- ls(paste0("package:", get_pkg_name())) # nolint internal function
 loglik_functions <- fun_list[sapply(
  fun_list, function(x)
   any(grepl("loglik", x))
 )]
 loglik_functions
}

#' Get the names of the parameters used in the model
#' @author Giovanni Laudanno
#' @export
get_param_names <- function() {
 c("lambda_m", "mu_m", "lambda_s", "mu_s")
}
richelbilderbeek/splendid documentation built on May 20, 2019, 9:42 a.m.