simriscparams(7)

simrisc configuration file organization
(simrisc.13.03.00.tar.gz)

2020

NAME

simriscparams - The description of the
configuration files

DESCRIPTION

This page describes the organization of the simrisc configuration files. These files are formatted like standard unix configuration files. Lines are interpreted after removing initial white-space (blanks and tabs). If a line ends in \ (a backslash), then the next line (initial white-space removed) is appended to the current line.

While processing the configuration files trailing blanks and information on lines starting at the first # character are removed.

DEFAULT PARAMETER FILE

A default parameter file is provided as /usr/share/doc/simrisc/simrisc.gz.

Usually this file is unzipped to the ~/.config directory:


    gunzip < /usr/share/doc/simrisc/simrisc.gz > ~/.config/
   
whereafter ~/.config/simrisc can be edited to contain local modifications.

Various parameters specify probability distributions. By default this is the Normal distribution. The program also recognizes the LogNormal, Uniform, and Exponential distributions.

Parameter specifications start with keywords, followed by a colon. The keywords are shown in the following overview. The format of the specifications is also fixed, but white space may be added between elements to improve the specifications' readabilities. And of course end-of-line comment, starting at the # characters, may be used.

The default ~/.config/simrisc file contains the following parameters:

Modalities:

Currently three modalities are supported: Mammo, Tomo and MRI. Some specificity parameters use age groups. Like the age ranges used for breastDensities the age groups used for modalities are half-open ranges: they start at their begin ages, and end at (not including) their end-ages, age ranges must connect, and the last age group may use the end-age specification *.

Here are the default configurations of the currently implemented modalities:

Tumor parameters:

PARAMETER RESPECIFICATION

Parameters can be respecified by defining a separate parameter configuration file or by providing alternate parameter specifications in analyses: sections of the program's input file, or by providing alternative parameter specifications as command-line arguments (cf. the simrisc(3) man-page)

FILES

By default configuration files is expected in ~/.config/simrisc.

The default configuration file provided in the distribution is found in /usr/share/docs/simrisc/simrisc.gz

SEE ALSO

simrisc(1)

BUGS

too early for that ...

COPYRIGHT

This is free software, distributed under the terms of the GNU General Public License (GPL).

AUTHOR

Frank B. Brokken (f.b.brokken@rug.nl),