R/sits_model_export.R

In e-sensing/sits: Satellite Image Time Series Analysis for Earth Observation Data Cubes

#' @title Export classification models
#' @name sits_model_export
#' @author Rolf Simoes, \email{rolf.simoes@@inpe.br}
#'
#' @description Given a trained machine learning or deep learning model,
#' exports the model as an object for further exploration outside the
#' \code{sits} package.
#'
#' @param ml_model A trained machine learning model
#'
#' @return An R object containing the model in the original format of
#' machine learning or deep learning package.
#' @examples
#' if (sits_run_examples()) {
#'     # create a classification model
#'     rfor_model <- sits_train(samples_modis_ndvi, sits_rfor())
#'     # export the model
#'     rfor_object <- sits_model_export(rfor_model)
#' }
#'
#' @export
sits_model_export <- function(ml_model) {
    .check_is_sits_model(ml_model)
    # Dispatch
    UseMethod("sits_model_export", ml_model)
}
#' @rdname sits_model_export
#'
#' @export
sits_model_export.sits_model <- function(ml_model) {
    .check_is_sits_model(ml_model)
    # Extract the result of the R RandomForest package
    model <- .ml_model(ml_model)
    return(model)
}