cooks.distance: cooks.distance

cooks.distance.regional_mixR Documentation

cooks.distance

Description

Performs leave-some-out measures for a regional_mix model. This includes a measure of how much effect leaving out an observation has on the probability of each site's RCP label. Also, this function can be used as a cross-validation workhorse.

Usage

## S3 method for class 'regional_mix'
cooks.distance(
  model,
  ...,
  oosSize = 1,
  times = model$n,
  mc.cores = 1,
  quiet = FALSE
)

Arguments

model

A regional_mix object whose fit you want to assess

oosSize

The size of the with held partitions (out-of-sample size). Use 1 (default) for leave-one-out statistics, such as Cook's distance and leave-one-out validation.

times

The number of times to perform the re-estimation (the number of leave out groups). For each 1:times a random partition of the data, of size oosSize, is taken and the model is fitted to one of the partitions. It is predicted to the other partition. The exception is when oosSize=1 and times=model$n (leave-one-out). In such cases (the default too), the observations are left out one-by-one and not randomly.

mc.cores

The number of cores to spread the workload over. Default is 1. Argument is useless on Windows machines ??? see ?parallel::mclapply

quiet

Should printing be suppressed? Default is no, it should not. Note that in either case, printing of the iteration trace etc is suppressed for each regional_mix fit.

\dots

ignored

Value

An object of class regiCooksD. It is a list of 4 elements:

Y the species data,

CV the model$n by model$S by times array of out-of-sample predictions (this array contains a lot of NAs for where predictions would in-sample),

cooksD a model$n by model$nRCP matrix of statistics that resemble Cook's distance. The statistic is the change in the prediction of RCP probability from the model with all the data to the model with only the in-sample data, and predLogL the predictive log-likelihood of each point in each withheld sample (log-likelihood contributions of withheld observations, again there will be many NAs).

Examples

## Not run: 
#not run as R CMD check complains about the time taken.
#This code will take a little while to run (<1 minute on my computer)
#For leave-one-out cooks distance, use oosSize=1
#for serious use times will need to be larger.
system.time({
  example( regional_mix);
  cooksD <- cooks.distance( fm, oosSize=10, times=25)
})
#For leave-one-out cooks distance, use oosSize=1
cooksD <- cooks.distance( fm, oosSize=10, times=5)

## End(Not run)

skiptoniam/ecomix documentation built on Sept. 14, 2023, 6:04 a.m.