Skip to contents

Summary of Hmsc model parameters

Source: R/Mod_Summary.R
Mod_Summary.Rd

This function provides a comprehensive summary of Hmsc model parameters, including Alpha, Beta, Rho, and Omega. It processes the model's output, performs statistical summaries, and optionally returns the summarized data.

Usage

Mod_Summary(Path_Coda = NULL, EnvFile = ".env", ReturnData = FALSE)

Arguments

Path_Coda

Character. Path to the .qs2 / .RData file containing the coda object.

EnvFile

Character. Path to the environment file containing paths to data sources. Defaults to .env.

ReturnData

Logical. Whether the summarized data should be returned as an R object. If TRUE, the function returns a list containing summaries of Alpha, Beta, Rho, and Omega parameters. The default value is FALSE, which means the function will not return any data but will save the summaries to a specified directory.

Value

If ReturnData is FALSE (default), the function does not return anything and saves the summaries to a directory. If ReturnData is TRUE, it also returns the data as R object.

Author

Ahmed El-Gabbas