inputlist: User provided parameters

In GaDiFPT: First Passage Time Simulation for Gaussian Diffusion Processes

Description

inputlist creates an object of class “inputlist” from the given set of provided values. print shows an object of class “inputlist”.

Usage

inputlist(m,s,Sty,tini,xini,Tend,delta,Ntime,quadfl,RSfl)
## S3 method for class 'inputlist'
print(x, ...)

Arguments

m	gives the constant part of the infinitesimal drift of the process
s	gives the infinitesimal variance of the process
Sty	gives the functional type of the considered threshold
tini	gives the initial time in milliseconds
xini	gives the value of the resting potential of the process
Tend	gives the final time in milliseconds
delta	gives the timestep in milliseconds
Ntime	gives the total number of crossing times to be simulated
quadfl	is a flag denoting the requirement for full reconstruction of the FPT density by numerical integration of the Volterra equation
RSfl	is a technical flag to manage opening and closing of plot windows in case RStudio interface is used
x	an object of class “inputlist”
...	additional arguments potentially passed (currently none is considered).

Value

inputlist returns an object of class “inputlist” yielding the user-provided parameters as a named list. print.inputlist shows a brief summary of the user provided parameters.

Author(s)

A. Buonocore, M.F. Carfora

Examples

## Creating a list of parameters for the Wiener process

mu <- 0.0
sigma2 <- 1.0
Stype <- "constant"
t0 <- 0.0
x0 <- 0.0
Tfin <- 4000    
deltat <- 1.0
M <- 1000
quadflag <- 1
RStudioflag <- TRUE

# building an object of \dQuote(inputlist) class and printing a summary of its parameters

param <- inputlist(mu,sigma2,Stype,t0,x0,Tfin,deltat,M,quadflag,RStudioflag)

print(param)

GaDiFPT documentation built on May 2, 2019, 1:18 p.m.