File: print.vector_with_cause.Rd

package info (click to toggle)
r-cran-assertive.base 0.0-9-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, trixie
  • size: 476 kB
  • sloc: sh: 13; makefile: 2
file content (29 lines) | stat: -rw-r--r-- 894 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cause.R
\name{print.scalar_with_cause}
\alias{print.scalar_with_cause}
\alias{print.vector_with_cause}
\title{Print methods for objects with a cause attribute}
\usage{
\method{print}{scalar_with_cause}(x, ...)

\method{print}{vector_with_cause}(x, na_ignore = FALSE, n_to_show = 10, ...)
}
\arguments{
\item{x}{an object of class \code{scalar_with_cause} or
\code{vector_with_cause}.}

\item{...}{Currently unused.}

\item{na_ignore}{A logical value.  If \code{FALSE}, \code{NA} values
are printed; otherwise they do not.  Like \code{na.rm} in many
stats package functions, except that the position of the failing
values does not change.}

\item{n_to_show}{A natural number.  The maximum number of failures 
to show.}
}
\description{
Prints objects of class \code{scalar_with_cause} and 
\code{vector_with_cause}.
}