report.summary.fptl: Writing a Report of a summary.fptl Object

In fptdApprox: Approximation of First-Passage-Time Densities for Diffusion Processes

Writing a Report of a summary.fptl Object

Description

A report is generated with the information contained in an object of class “summary.fptl”.

Usage

## S3 method for class 'summary.fptl'
report(obj, tex = FALSE, digits = 8, heading = TRUE, ...)

Arguments

obj	an object of class “summary.fptl”, a result of a call to summary.fptl function or the attribute summary.fptl of the value (of class “fpt.density”) of the Approx.fpt.density function (created through one or several successive internal calls to the summary.fptl function).
tex	logical, specifies whether to generate formatted LaTeX output (TRUE) or plain text file (FALSE).
digits	integer indicating the significant digits to be used.
heading	logical, specifies whether to include information about the diffusion process and the boundary (TRUE) or not (FALSE).
...	additional arguments potentially passed (currently none is considered).

Details

The resulting report can be recicled by copy-and-pasting into a document (if tex = FALSE) or directly included into a LaTeX file (if tex = TRUE).

Value

Send the report to the command windows.

Author(s)

Patricia Román-Román, Juan J. Serrano-Pérez and Francisco Torres-Ruiz.

References

P. Román-Román, J.J. Serrano-Pérez, F. Torres-Ruiz. (2012) An R package for an efficient approximation of first-passage-time densities for diffusion processes based on the FPTL function. Applied Mathematics and Computation, 218, 8408–8428.

P. Román-Román, J.J. Serrano-Pérez, F. Torres-Ruiz. (2014) More general problems on first-passage times for diffusion processes: A new version of the fptdApprox R package. Applied Mathematics and Computation, 244, 432–446.

See Also

summary.fptl to create objects of class “summary.fptl” from objects of class “fptl”.

Approx.fpt.density to create objects of class “fpt.density” with the attribute summary.fptl of class “summary.fptl”

is.summary.fptl to test whether an object is of class “summary.fptl”.

Examples

## Continuing the summary.fptl(.) example:

report(yy, digits = 4)
report(yy, tex = TRUE, digits = 4)

report(zz)
report(zz, tex = TRUE)

fptdApprox documentation built on Nov. 2, 2023, 5:07 p.m.