summary.brsdata: Summarise dose-response data

In pjbouchet/espresso: Bayesian Inference For Multi-Species Behavioural Dose-response Functions

Summarise dose-response data

Description

Summary method for objects of class brsdata. Print a text-based summary of the data in the R console.

Usage

## S3 method for class 'brsdata'
summary(dat.obj, print.config = TRUE)

Arguments

dat.obj	Input dataset. Must be an object of class brsdata, as returned by read_data or simulate_data.
print.config	Logical. Whether to print a summary of MCMC parameters, when the data have been configured using configure_MCMC.

Value

A text-based summary of dataset properties.

Author(s)

Phil J. Bouchet

See Also

read_data simulate_data

Examples

## Not run: 
library(espresso)

# Simulate data for two species
mydat <- simulate_data(n.species = 2, 
                      n.whales = 16, 
                      max.trials = 3, 
                      covariates = list(exposed = c(0, 5), range = 10)
                      mu = c(125, 158), 
                      phi = 20, 
                      sigma = 20, 
                      Rc = c(210, 211), 
                      seed = 58697)
                      
summary(mydat)

## End(Not run)

pjbouchet/espresso documentation built on July 27, 2024, 12:31 p.m.