dynr-package

tools:::Rd_package_title("dynr")

tools:::Rd_package_description("dynr") package

Details

The DESCRIPTION file: tools:::Rd_package_DESCRIPTION("dynr")

tools:::Rd_package_indices("dynr")

Because the dynr package compiles C code in response to user input, more setup is required for the dynr package than for many others. We acknowledge that this additional setup can be bothersome, but we believe the ease of use for the rest of the package and the wide variety of models it is possible to fit with it will compensate for this initial burden. Hopefully you will agree!

See the installation vignette referenced in the Examples section below for installation instructions.

The naming convention for dynr exploits the pronunciation of the package name, dynr, pronounced the same as ``dinner''. That is, the names of functions and methods are specifically designed to relate to things done surrounding dinner, such as gathering ingredients (e.g., the data), preparing recipes, cooking, and serving the finished product. The general procedure for using the dynr package can be summarized in five steps as below.

1. Data are prepared using with the dynr.data() function.
2. Recipes are prepared. To each part of a model there is a corresponding prep.*() recipe function. Examples of such prep.*() functions include: prep.measurement(), prep.matrixDynamics(), prep.formulaDynamics(), prep.initial(), prep.noise(), and prep.regimes().
3. The function dynr.model() mixes the data and recipes together into a model object of class dynrModel.
4. The model is cooked with dynr.cook().
5. Results from model fitting and related estimation are served using functions such as summary(), plot(), dynr.ggplot() (or its alias autoplot()), plotFormula(), and printex().

Author(s)

tools:::Rd_package_author("dynr")

Maintainer: tools:::Rd_package_maintainer("dynr")

References

Rdpack::insert_ref(key="Chow13a",package="dynr")

Rdpack::insert_ref(key="Chow13b",package="dynr")

Rdpack::insert_ref(key="Ou17b",package="dynr")

Rdpack::insert_ref(key="Yang10a",package="dynr")

Rdpack::insert_ref(key="Chow17a",package="dynr")

Note

State-space modeling, dynamic model, differential equation, regime switching, nonlinear

See Also

For other annotated tutorials using the dynr package see

Examples

# For installation instructions see the package vignette below
## Not run:

vignette(package='dynr', 'InstallationForUsers')
## End(Not run)

# This should open a pdf/html file to guide you through proper
#  installation and configuration.

#For illustrations of the functions in dynr, check out some of the demo examples in:
## Not run:

demo(package='dynr')
## End(Not run)

#For example, to run the demo 'LinearSDE' type
# the following without the comment character (#) in front of it.
## Not run:

demo('LinearSDE', package='dynr')
## End(Not run)