IsoriX: isomultifit – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

isomultifit

Fit isoscape models per strata (typically time interval such as months)

Description

This function fits several set of isoscapes (e.g. one per strata). It can thus be used to predict annual averages precipitation weighted isoscapes.

Usage

isomultifit(
  data,
  split_by = "month",
  mean_model_fix = list(elev = FALSE, lat_abs = FALSE, lat_2 = FALSE, long = FALSE,
    long_2 = FALSE),
  disp_model_fix = list(elev = FALSE, lat_abs = FALSE, lat_2 = FALSE, long = FALSE,
    long_2 = FALSE),
  mean_model_rand = list(uncorr = TRUE, spatial = TRUE),
  disp_model_rand = list(uncorr = TRUE, spatial = TRUE),
  uncorr_terms = list(mean_model = "lambda", disp_model = "lambda"),
  spaMM_method = list(mean_model = "fitme", disp_model = "fitme"),
  dist_method = "Earth",
  control_mean = list(),
  control_disp = list(),
  verbose = interactive()
)

Arguments

`data`	The `dataframe` containing the data used for fitting the isoscape model
`split_by`	A `string` indicating the name of the column of `data` used to split the dataset. The function `isofit` will then be called on each of these sub-datasets. The default behaviour is to consider that the dataset should be split per months (`split_by = "month"`).
`mean_model_fix`	A `list` of `logical` indicating which fixed effects to consider in mean_fit
`disp_model_fix`	A `list` of `logical` indicating which fixed effects to consider in disp_fit
`mean_model_rand`	A `list` of `logical` indicating which random effects to consider in mean_fit
`disp_model_rand`	A `list` of `logical` indicating which random effects to consider in disp_fit
`uncorr_terms`	A `list` of two strings defining the parametrization used to model the uncorrelated random effects for mean_fit and disp_fit
`spaMM_method`	A `list` of two strings defining the spaMM functions used for mean_fit and disp_fit
`dist_method`	A `string` indicating the distance method
`control_mean`	A `list` of additional arguments to be passed to the call of mean_fit
`control_disp`	A `list` of additional arguments to be passed to the call of disp_fit
`verbose`	A `logical` indicating whether information about the progress of the procedure should be displayed or not while the function is running. By default verbose is `TRUE` if users use an interactive R session and `FALSE` otherwise.

Details

This function is a wrapper around the function isofit.

Value

This function returns a list of class MULTIISOFIT containing all pairs of inter-related fits (stored under multi_fits). The returned list also contains the object info_fit that contains all the call arguments.

Examples

## The examples below will only be run if sufficient time is allowed
## You can change that by typing e.g. options_IsoriX(example_maxtime = XX)
## if you want to allow for examples taking up to ca. XX seconds to run
## (so don't write XX but put a number instead!)

if(getOption_IsoriX("example_maxtime") > 30) {

## We prepare the GNIP monthly data between January and June for Germany

GNIPDataDEmonthly <- prepsources(data = GNIPDataDE,
                                 month = 1:6,
                                 split_by = "month")

head(GNIPDataDEmonthly)

## We fit the isoscapes

GermanMonthlyFit <- isomultifit(data = GNIPDataDEmonthly)

GermanMonthlyFit

plot(GermanMonthlyFit)
}

IsoriX

Isoscape Computation and Inference of Spatial Origins using Mixed Models

v0.8.2

GPL (>= 2)

Authors

Alexandre Courtiol [aut, cre] (<https://orcid.org/0000-0003-0637-2959>), François Rousset [aut] (<https://orcid.org/0000-0003-4670-0371>), Marie-Sophie Rohwaeder [aut], Stephanie Kramer-Schadt [aut] (<https://orcid.org/0000-0002-9269-4446>)

Initial release