generateSiberData: A utility function to simulate isotope data for several...

View source: R/generateSiberData.R

generateSiberDataR Documentation

A utility function to simulate isotope data for several communities

Description

This function simulates data for a specified number of communities. It is a wrapper function for generateSiberCommunity().

Usage

generateSiberData(
  n.groups = 3,
  n.communities = 2,
  n.obs = 30,
  mu.range = c(-1, 1, -1, 1),
  wishSigmaScale = 1
)

Arguments

n.groups

the an integer specifying the number of groups per community to simulate. Defaults to 3.

n.communities

the number of communities to simulate data for. Defaults to 2.

n.obs

the number of observations to draw per group.

mu.range

a vector of length 4, specifying the mix and max x and y values to sample means from. Group means are sampled from a uniform distribution within this range. The first two entries are the min and max of the x-axis, and the second two the min and max of the y-axis. Defaults to c(-1, 1, -1, 1).

wishSigmaScale

is a simple multiplier for the call to stats::rWishart() which scales the diagonal sigma matrix using wishSigmaScale * diag(2) that is ultimately passed on to generateSiberGroup.

Value

A data.frame object comprising a column of x and y data, a group identifying column and a community identifying column, all of which are numeric.

Examples

generateSiberData()


AndrewLJackson/SIBER documentation built on June 7, 2024, 3:21 a.m.