Create reports — report • persephone

Create html reports that present the model performance, including, fitting, predictions, evaluation metrics and corresponding plots.

Usage

report(object, ...)

# S4 method for ProgressModel
report(
  object,
  name = NULL,
  path = cronus::get_path_hermes(),
  test = 0.25,
  maxsam = 500,
  seed = 1
)

# S4 method for ProgressModelList
report(object, ...)

Arguments

object: an object of class ProgressModel or ProgressModelList.
...: extra arguments.
name: character. The html file name.
path: character. The path to store the html report.
test: Passed to persephone::evaluate().
maxsam: Passed to persephone::evaluate().
seed: Passed to persephone::evaluate().

Value

nothing. The html report(s) is (are) created and stored.

Examples

if (FALSE) {
# Create a Region object
library(cronus)
region <- Region(name = "nebraska", type = "us state",
                 div = c(country = "United States", state = "Nebraska"))

# Create a model
object1 <- new("ProgressBM",
               region = region,
               crop = "Corn",
               data = data_progress$Corn,
               formula = "CumPercentage ~ Time + agdd") # ProgressModel

# Create another model
object2 <- new("ProgressCLM",
               region = region,
               crop = "Soybeans",
               data = data_progress$Soybeans,
               formula = "Stage ~ Time + agdd + adayl") # ProgressModel

# Concatenate the models
object <- c(object1, object2) # ProgressModelList

# Fit
object <- fit(object)

# Plot
plot(object, cumulative = TRUE, seasons = 2002)

# Predict
predict(object, data_progress)

# Evaluate
object <- evaluate(object, maxsam = 100, seed = 1)
plot_metrics(object)

# Summarize
summary(object)

# Report
report(object, name = "example_report", path = getwd())
}