sits (version 1.4.1)

summary.probs_cube: Summarize data cubes

Description

This is a generic function. Parameters depend on the specific type of input.

Usage

# S3 method for probs_cube
summary(
  object,
  ...,
  tile = object$tile[[1]],
  only_stats = FALSE,
  sample_size = 1e+05
)

Value

A summary of a probability cube

Arguments

object

Object of class "probs_cube"

...

Further specifications for summary.

tile

Tile to be summarized

only_stats

Show only the statistics? (TRUE/FALSE)

sample_size

Number of sample used to build statistics

Author

Gilberto Camara,

Examples

if (sits_run_examples()) {
    # create a data cube from local files
    data_dir <- system.file("extdata/raster/mod13q1", package = "sits")
    cube <- sits_cube(
        source = "BDC",
        collection = "MOD13Q1-6",
        data_dir = data_dir
    )
    # create a random forest model
    rfor_model <- sits_train(samples_modis_ndvi, sits_rfor())
    # classify a data cube
    probs_cube <- sits_classify(
        data = cube, ml_model = rfor_model, output_dir = tempdir()
    )
    summary(probs_cube)
}