alpha_estimate {breakaway}

alpha_estimate

Description

Build objects of class alpha_estimate from their components. alpha_estimate() is a constructor method

Usage

alpha_estimate(
  estimate = NULL,
  error = NULL,
  estimand = NULL,
  name = NULL,
  interval = NULL,
  interval_type = NULL,
  type = NULL,
  model = NULL,
  warnings = NULL,
  frequentist = NULL,
  parametric = NULL,
  plot = NULL,
  reasonable = NULL,
  other = NULL,
  ...
)

Arguments

estimate

The estimate

error

The standard error in the estimate

estimand

What is the estimate trying to estimate? (richness, Shannon...)

name

The name of the method

interval

An interval estimate

interval_type

Type of interval estimate

type

TODO(Amy): Deprecate?

model

What model is fit

warnings

Any warnings?

frequentist

Logical. Frequentist or Bayesian?

parametric

Logical. Parametric or not?

plot

A ggplot associated with the estimate

reasonable

Is the estimate likely to be reasonable?

other

Any other relevant objects

...

Any other objects

Value

An object of class alpha_estimate