CImean: Confidence interval of a dataset variable's sample mean in...

View source: R/CImean.r

CImeanR Documentation

Confidence interval of a dataset variable's sample mean in table and figure

Description

Reports the confidence interval of a sample mean in table and plot. Default is 95% CI but use can raise or lower confidence level.

Usage

CImean(x, w, data, digits = 3, level = 95, pop.sd, printC = FALSE,
  plot = TRUE, main, xlab, xlim, ...)

Arguments

x

A numeric variable, should be in dataset$var form unless dataset specified in optional data argument.

w

(Optional) Sampling weights of variable (optional), must be numeric; should be in dataset$weightvar form unless dataset specified in optional data argument.

data

(Optional) Name of dataset that contains x (and w) variable (optional).

digits

(Optional) Number of decimal places reported in result (defaults to 3).

level

(Optional) A single number equal to the desired confidence level (i.e. 95, 99, 90, etc.). Default value is 95 percent confidence level.

pop.sd

(Optional) A single number equal to the known population standard deviation of x. This value is rarely know, but if it is, critical values for confidence interval are based on standard normal distribution.

printC

(Optional) Do you want results printed to .html file in your working directory? Default is FALSE. Set to TRUE to print results.

plot

(Optional) Do you want a plot of the confidence interval? Default is TRUE.

main

(Optional) Change the main title of plot. Default title generated from level, x, and w.

xlab

(Optional) Label for x-axis of confidence interval plot.

xlim

(Optional) Modify x-axis limits of confidence interval plot.

...

(Optional) additional arguments passed to plot function.

Value

Returns the confidence interval as a vector of numeric values (the lower and upper bounds).

RCPA3 Package Tutorial Videos

Textbook References

  • Philip H. Pollock and Barry C. Edwards, An R Companion to Political Analysis, 3rd Edition (Thousand Oaks, CA: Sage Publications, Forthcoming 2022), Chapter 8.

  • Philip H. Pollock and Barry C. Edwards, The Essentials of Political Analysis, 6th Edition (Thousand Oaks, CA: Sage Publications, 2020), pp. 184-186. ISBN-13: 978-1506379616; ISBN-10: 150637961.

Online Resources

Examples

 
  library(RCPA3)
  
  CImean(nes$age)
  
  
  # using optional w, level, and data arguments
  CImean(x=nes$age, w=nes$wt, level=90)
  CImean(x=age, data=nes, level=95)
  

RCPA3 documentation built on May 29, 2024, 12:19 p.m.

Related to CImean in RCPA3...