inzinference: iNZight Inference Method

View source: R/inzinference.R

inzinferenceR Documentation

iNZight Inference Method

Description

A generic function used to generate inferential information for objects within the iNZight ecosystem.

Usage

inzinference(x, ..., env = parent.frame())

## S3 method for class 'formula'
inzinference(
  x,
  data = NULL,
  design = NULL,
  type = c("conf", "comp"),
  ...,
  env = parent.frame()
)

Arguments

x

An object

...

additional arguments for methods

env

an environment to evaluate things

data

Dataset to plotq

design

A survey design to use

type

Type type of inference to obtain, one of 'conf' or 'comp' for confidence intervals and comparison intervals, respectively (currently ignored).

Value

The output depends on the type of input, and consists of a inference object with a print method.

Methods (by class)

  • inzinference(formula): Wrapper for getPlotSummary to obtain inference information about a plot


iNZightVIT/iNZightPlots documentation built on April 8, 2024, 10:24 a.m.