LatCR: Latitudinal classical rarefaction

Description Usage Arguments Value

View source: R/LatCR.R

Description

Latitudinal classical rarefaction

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
LatCR(
  data,
  bandsize = 15,
  n = "minimum",
  threshold = 5,
  iterations = 100,
  reps = FALSE,
  replace = TRUE,
  write = FALSE,
  name = "simulation"
)

Arguments

data

Dataframe (colnames: rep, species, x, y). A dataframe containing species ID, occurrences and (optional) replications.

bandsize

Integer. Size of latitudinal bins/bands desired for analyses.

n

Integer or "minimum". Defaults to minimum number of occurrences in bins, otherwise a value can be specified (e.g. n = 20 occurrences).

threshold

Integer. Integer value used to discard any bins equal to or less than threshold.

iterations

Integer. Defaults to 100, number of iterations to sample each rep for.

reps

Logical. If replications >1, reps should be defined as TRUE. Defaults to FALSE.

replace

Logical. If TRUE, sampling is done with replacement. Defaults to TRUE.

write

Logical. If true, a dataframe of latitudinal diversity is wrote to disk.

name

Character. File name of dataframe.

plot

Logical. If TRUE, a plot is generated.

Value

A dataframe of latitudinal diversity.


LewisAJones/LBGSim documentation built on March 28, 2020, 12:03 a.m.