R/ANN-class.R

In SDMtune: Species Distribution Model Selection

setOldClass("nnet")
#' Artificial Neural Network
#'
#' This Class represents an Artificial Neural Network model object and hosts
#' all the information related to the model.
#'
#' @slot size integer. Number of the units in the hidden layer.
#' @slot decay numeric. Weight decay.
#' @slot rang numeric. Initial random weights.
#' @slot maxit integer. Maximum number of iterations.
#' @slot model [nnet][nnet::nnet]. The nnet model object.
#'
#' @details See [nnet][nnet::nnet] for the meaning of the slots.
#'
#' @rdname ANN-class
#' @export
#'
#' @author Sergio Vignali
ANN <- setClass("ANN",
                slots = c(
                  size = "numeric",
                  decay = "numeric",
                  rang = "numeric",
                  maxit = "numeric",
                  model = "nnet")
)

#' @param object ANN object
#' @rdname ANN-class
setMethod("show",
          signature = "ANN",
          definition = function(object) {
            cli::cli_h2("Object of class: {.cls {class(object)}}")

            cli::cli_par()
            cli::cli_text("Method: {.emph Artificial Neural Networks}")
            cli::cli_end()

            cli::cli_h3("Hyperparameters")

            cli::cli_li("{.field size}: {.val {object@size}}")
            cli::cli_li("{.field decay}: {.val {object@decay}}")
            cli::cli_li("{.field rang}: {.val {object@rang}}")
            cli::cli_li("{.field maxit}: {.val {object@maxit}}")
          })