beta {proxirr} | R Documentation |
Calculate Beta Irreplaceability
Description
This function calculates Beta irreplaceability. Inputs can be either a vector
of Alpha values, or a data.frame
containing all necessary parameters
needed to calculate Alpha values on a row-by-row basis.
-
Vector Beta measurement: If
data
is a vector of Alpha irreplaceability values, a single Beta value will be calculated and returned. -
Dataframe Beta measurement: If
data
is adata.frame
andlocal
,global
andtarget
are strings representing field names indata
, a vector of Alpha irreplaceability values will be caluclated using these fields, and a Beta irreplaceability value will be calculated on these, and returned.
Usage
beta(
data,
local = NULL,
global = NULL,
target = NULL,
triage = FALSE,
na.rm = TRUE
)
Arguments
data |
vector or data.frame - The input over which to calculate Beta. |
local |
string - The name of the column containing the feature's
representation at the site. Needed if data is a |
global |
string - The name of the column containing the feature's total
available representation. Needed if data is a |
target |
string - The name of the column containing the feature's target.
Needed if data is a |
triage |
logical - Should features with unachievable targets be ignored? Defaults to FALSE. If FALSE, these species will be always assigned an Alpha irreplaceability of 1 wherever they occur. If TRUE, these species will always be assigned an Alpha irreplaceabiltiy of 0. |
na.rm |
logical - Should lines with missing values (NA) be ignored? If
data is a |
Value
A number
Author(s)
Daniele Baisero, daniele.baisero@gmail.com
Examples
beta(c(0.01, 0.5, 0.5))
dtfrm = data.frame(
loc = c(1,25,45),
glob = c(100,100,100),
targ = c(50,50,50)
)
beta(dtfrm, local = 'loc', global = 'glob', target = 'targ')