gaze: Short print of the summary of an object

View source: R/gaze.R

gazeR Documentation

Short print of the summary of an object

Description

print and print.summary methods often returns long input, which is suitable for the console, but too verbal for a printed output like a book or an article written using quarto. gaze is a generic function which prints a short output

Usage

gaze(x, ...)

## S3 method for class 'lm'
gaze(
  x,
  ...,
  coef = NULL,
  digits = max(3L, getOption("digits") - 3L),
  signif.stars = FALSE
)

## S3 method for class 'micsr'
gaze(
  x,
  ...,
  coef = NULL,
  digits = max(3L, getOption("digits") - 3L),
  signif.stars = FALSE
)

## S3 method for class 'ivreg'
gaze(
  x,
  ...,
  coef,
  digits = max(3L, getOption("digits") - 3L),
  signif.stars = getOption("show.signif.stars")
)

## S3 method for class 'rdrobust'
gaze(x, ..., first_stage = FALSE)

## S3 method for class 'CJMrddensity'
gaze(x, ...)

## S3 method for class 'htest'
gaze(x, ..., digits = 3)

## S3 method for class 'anova'
gaze(x, ..., digits = 3)

## S3 method for class 'LMtestlist'
gaze(x, ..., digits = 3)

Arguments

x

an object,

...

further arguments for the different methods,

coef

the coefficients to be printed

digits

the number of digits for the lm and the ivreg methods

signif.stars

a boolean indicating whether the stars should be printed

first_stage

a boolean for the rdrobust::rdrobust method, if TRUE the results of the first stage estimation are printed

Value

returns invisibly its first argument

Examples

t.test(extra ~ group, sleep) %>% gaze
lm(dist ~ poly(speed, 2), cars) %>% gaze
lm(dist ~ poly(speed, 2), cars) %>% gaze(coef = "poly(speed, 2)2")

micsr documentation built on May 29, 2024, 7:32 a.m.