R Graphical Manual

Browse All

Last data update: 2014.03.03

R: User provided parameters

inputlist

R Documentation

User provided parameters

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)

Results


R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(GaDiFPT)
> png(filename="/home/ddbj/snapshot/RGM3/R_CC/result/GaDiFPT/inputlist.Rd_%03d_medium.png", width=480, height=480)
> ### Name: inputlist
> ### Title: User provided parameters
> ### Aliases: inputlist print.inputlist t0 x0 Tfin deltat M quadflag
> ###   RStudioflag
> 
> ### ** 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)
###  Summary of the input parameters: ###
     
 Initial time t0 =  0 
 Initial state x0 =  0 
 Final time Tfin (ms) =  4000 
 Timestep delta t (ms) =  1 
 Threshold type =  constant 
 Number of spikes to be simulated =  1000 

 Numerical Integration up to Tfin required 
 
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>