advEfficiency {actel}R Documentation

Calculate beta estimations for efficiency

Description

advEfficiency estimates efficiency ranges by fitting a beta distribution with parameters α = number of detected tags and β = number of missed tags. The desired quantiles (argument q) are then calculated from distribution. Plots are also drawn showing the distribution, the median point (dashed red line) and the range between the lowest and largest quantile requested (red shaded section).

Usage

advEfficiency(
  x,
  labels = NULL,
  q = c(0.025, 0.5, 0.975),
  force.grid = NULL,
  paired = TRUE,
  title = ""
)

Arguments

x

An efficiency object from actel (overall.CJS, intra.array.CJS[[...]] or efficiency objects)

labels

a vector of strings to substitute default plot labels

q

The quantile values to be calculated. Defaults to c(0.025, 0.5, 0.975) (i.e. median and 95% CI)

force.grid

A vector of format c(nrow, ncol) that allows the user to define the number of rows and columns to distribute the plots in.

paired

Logical: For efficiency derived from residency analyses, should min. and max. estimates for an array be displayed next to each other?

title

A title for the plot (feeds into title parameter of ggplot's labs function).

Details

Examples for inclusion in a paper:

  1. If advEfficiency was run on an overall.CJS object (i.e. migration analysis):

    "Array efficiency was estimated by fitting a beta distribution (α = number of tags detected subsequently and at the array, β = number of tags detected subsequently but not at the array) and calculating the median estimated efficiency value using the R package actel [citation]."

  2. If advEfficiency was run on an efficiency object (i.e. residency analysis):

    • If you are using maximum efficiency estimates:

      "Array efficiency was estimated by fitting a beta distribution (α = number of events recorded by the array, β = number of events known to have been missed by the array). and calculating the median estimated efficiency value using the R package actel [citation]."

    • If you are using minimum efficiency estimates:

      "Array efficiency was estimated by fitting a beta distribution (α = number of events recorded by the array, β = number of events both known to have been missed and potentially missed by the array). and calculating the median estimated efficiency value using the R package actel [citation]."

  3. If advEfficiency was run on an intra.array.CJS object:

    "Intra-array efficiency was estimated by comparing the tags detected at each of the two replicates. For each replicate, a beta distribution was fitted (α = number of tags detected at both replicates, β = number of tags detected at the opposite replicate but not at the one for which efficiency is being calculated) and the median estimated efficiency value was calculated. The overall efficiency of the array was then estimated as 1-((1-R1)*(1-R2)), where R1 and R2 are the median efficiency estimates for each replicate. These calculations were performed using the R package actel [citation]."

Replace [citation] with the output of citation('actel')

Value

A data frame with the required quantile values and a plot of the efficiency distributions.

Examples

# Example using the output of simpleCJS.
x <- matrix(
c(TRUE,  TRUE,  TRUE,  TRUE,  TRUE,
  TRUE, FALSE,  TRUE,  TRUE, FALSE,
  TRUE,  TRUE, FALSE, FALSE, FALSE,
  TRUE,  TRUE, FALSE,  TRUE,  TRUE,
  TRUE,  TRUE,  TRUE, FALSE, FALSE),
ncol = 5, byrow = TRUE)
colnames(x) <- c("Release", "A1", "A2", "A3", "A4")
cjs.results <- simpleCJS(x)

# These cjs results can be used in advEfficiency
advEfficiency(cjs.results)

# Example using the output of dualArrayCJS.
x <- matrix(
c( TRUE,  TRUE,
   TRUE, FALSE,
   TRUE,  TRUE,
  FALSE,  TRUE,
  FALSE,  TRUE),
ncol = 2, byrow = TRUE)
colnames(x) <- c("A1.1", "A1.2")
cjs.results <- dualArrayCJS(x)

# These cjs results can be used in advEfficiency
advEfficiency(cjs.results)

# advEfficiency can also be run with the output from the main analyses.
# the example.results dataset is the output of a migration analysis
advEfficiency(example.results$overall.CJS)


[Package actel version 1.2.1 Index]