----------------------------------------------------
lines 6-87 of file: at_cascade/check_cascade_node.py
----------------------------------------------------

{xrst_begin check_cascade_node}
{xrst_spell
  avgint
}

Check the Cascade Results for a Node
####################################

Prototype
*********
{xrst_literal
    # BEGIN_DEF
    # END_DEF
}

rate_true
*********
This argument
is a function with the following syntax
```
rate = rate_true(rate_name, a, t, n, c)
```

rate_name
=========
The argument *rate_name* is one of the following:
:ref:`glossary@iota`,
:ref:`glossary@rho`,
:ref:`glossary@chi`, or
:ref:`glossary@omega`.

a, t
====
The argument *a* ( *t* ) is the age ( time ) at which we
are evaluating the rate.

n
=
The argument *n* is the :ref:`glossary@node_name` for the
node where we are evaluating the rate.

c
=
The argument *c* is a list of covariate values
in the same order as the covariate table.

rate
====
The result *rate* is the corresponding value for the rate.

all_node_database
*****************
is a python string specifying the location of the
:ref:`all_node_db-name`
relative to the current working directory.

fit_database
************
is a python string specifying the location of a
dismod_at database relative to the current working directory.
It is a :ref:`glossary@fit_database` with the
extra properties listed under
:ref:`cascade_root_node@Output dismod.db`
in the cascade_root_node documentation.

avgint_table
************
This an avgint table specifying the predictions to check.
The node_id in this table does not matter because the parent node
in the fit_database is used in its place.
The avgint table in the *fit_database* is replaced using this argument.

relative_tolerance
******************
Is an upper bound for the relative error in the predictions
corresponding to the avgint table.
The error is the prediction using the true rates
minus the prediction using the estimated rates.
If this argument is ``None``, the maximum relative error is printed.
This is intended as an aid in setting the relative tolerance.

{xrst_end check_cascade_node}