RFoptions {adoption} | R Documentation |
RFoptions
sets and returns control arguments for the analysis
and the simulation of random fields.
See RFoptions
for the
definition of RFoptions(..., no.readonly = TRUE)
.
Note that this function can only be used after
library(RandomFieldsUtils)
has been made available explicitely.
The parameter for adoption are
logical.
The gui has many buttons and sliders. If
buttons2right=TRUE
all buttons are placed on the right of the graphics, else about half
of the stuff is placed below the graphics which gives a more compact view.
if buttons2right
is not given, it is TRUE
for Windows
sytems, else FALSE
. For Windows systems buttons2right=FALSE
does not work (The author is happy to get any hint why).
Default: NA
cores
Number of cores for multicore algorithms; currently only used for the Cholesky decomposition.
Default : 1
cumfit
Logical variable that directs the model fitting
by least squares.
If TRUE
the model is fitted to the cummulative distribution
function of the data, if FALSE
to the density function.
Default : TRUE
string. The extension name R data files.
Default: "rda"
control parameter of optim
Default: 1e14
base name of the pdf files when the images are stored by mean of the button ‘Images -> pdf’. The user may change the name in the gui.
Only the basic name should be given, no extensio. Then a bundle of pictures is created when the button ‘Images -> pdf’ is pressed. Also an rda file is created that contains the whole session information.
Default: "adoption"
fit_m
logical.
if TRUE
the market size m
is also
estimated. In the case, the estimation time is massively
increased.
Default: FALSE
fit_operators
If FALSE
, what is the default, the
parameters alpha
, beta
, gamma
and Uthreshold
are not suggested to be fitted.
fit_repetitions
Positive integer for the precision of the fitting.
The actual number of repetitions used in the model fitting is the
maximum of fit_repetitions
and the value of the slider
‘repetitions’.
Default : 10
integer between 6 and 12 or NA.
If font.size
is NA
, it chosen 7 for Windows sytems, else
8.
Default: NA
logical. If TRUE
the gui is opened. If FALSE
the calculations for the first model are performed.
The results are returned in model form.
Additionally if printlevel
$>0
(what is the default) all the graphics are drawn on the default
graphical device.
Default: TRUE
logical. If TRUE
the model(s) passed by
user
are joined with the list of standard models. If it is
FALSE
the list of models in the gui are replaced by the user
models. If it is NA
and
user
contains a single model then
it behaves as join_models = TRUE
Default: NA
integer. The fitting of the
complete fitting procedure is stopped
if no improvement is observed in max_increasing
subsequent global iteration steps.
Default: 3
integer.
Each slider is divided into numberSteps
parts.
When one of the borders is crossed a new simulation is calculated.
If numberSteps
is large enough, this leaves the impression
that the figures are continuously updated.
Default: 25
control parameter of optim
Default: 1e-1
Logical.
Graphical parameter. If TRUE
then density functions and
cumulative distribution functions are shown, multiplied by 100.
If FALSE
then frequencies and
cumulative frequencies are shown.
If NA
then actual value of ratio
is TRUE
iff no data are given.
ratio
does not have
an influence how parameters are fitted to data; the fitting is
always based on frequency data.
Default: TRUE
string giving the system command to create a screen shot.
Default: "xfce4-screenshooter -w -s ."
integer scalar or vector.
If it is a vector, it specifies the individuals, for which the
utility functions should be shown. If it is a single number,
it plots the utilities of the individuals 1:show.n.indiv
.
Default: 10
logical or integer. This option controls the behavior of entry boxes.
If it has 1
the simulations are updated by the tcltk
binding "<FocusOut>", i.e. whenever another entry box is entered.
values greater than 1 then the binding is "<KeyRelease>",
i.e. simulations are updated whenever a key is pressed.
If FALSE
or 0
no binding happens; so an update does
not happen and updates must be foreced through the button
‘new simulation’
Relative position of the sliders on the right handside of the graphics.
Default: Windows:50' Linux:38
integer.
the nth model within the list included.model
to start with. This option is only considered if user
is not a filename.
Default: 1
internal logical or integer value.
Tstart
and Tend
give start and end point,
respectively, of the simulation period. The time step is given
in the gui.
Default : 1
if wait
is negative, the prompt reappears after the gui is
launched. The current session model is stored in
.adoption.exit
in the .GlobalEnv
when leaving the gui.
If wait
is non-negative,
the system checks every wait
milli seconds
whether the gui has finished and returns the current session
model.
Default: 5000
windows
logical.
If TRUE
the fitting progress is shown in a separate window.
If NA
the value is set to TRUE
iff the operation
system is Windows.
Default: NA
.
Vector of 5 numbers that determines the rescaling of the graphs for dN, so that the same scale is kept as long as the values of dN are not too small and too large relative to the current scale.
Let c be the current upper limit of the graph and n the maximum value of dN for the next graph to be plotted. Then the following rules are applied.
While n > c * ymax[1]
do
c ≤ftarrow c *ymax[2]
If n < c /ymax[3]
and
c ≥ ymax[4] * m / 100
then c ≤ftarrow c / ymax[5]
.
Default: c(1.3, 3, 6.7, 0.02, 6)
NULL
if any argument is given, and the full list of
arguments, otherwise.
Martin Schlather, schlather@math.uni-mannheim.de, http://ms.math.uni-mannheim.de
N.N., Schlather, M., N.N., (2019) Toward a Generalized Adoption Modeling Framework. Manuscript.
Schlather, M. (2018) Introduction to the Gui of the R package 'adoption'. Technical Report. Attached with the package.
library(RandomFieldsUtils) RFoptions(GETOPTIONS="adoption") RFoptions(ymax=c(1.2, 2, 0.25, 0.02, 4)) adoption(gui=interactive())