# Getting started with Dyn4cast

## Installation

`Dyn4cast` is not yet on CRAN, so only the development version is available. However, the package is very functional and stable and is actively being watched for any issue. Presently, it has passed all the tests it was subjected to as can be seen here.

To install the development version of `Dyn4cast` from GitHub, use the following canonical form:

    # install.packages("devtools")
    pak::pak("JobNmadu/Dyn4cast")

The development version can also be installed through r-universe. Use the form:

    install.packages("Dyn4cast", repos = c("https://jobnmadu.r-universe.dev", "https://cloud.r-project.org"))

## Suggested packages

A number of other packages are required for the smooth running of the package and may need to be installed if not already installed on your machine. Some of the packages are listed below:

    install.packages(c(
      "lubridate", "tidyverse", "xlsx", "readxl", "rmarkdown",
      "covr", "caret", "kableExtra", "knitr", "spelling",
      "psych", "lifecycle", "MetBrewer", "data.table", "ggtext",
      "lubridate", "forecast", "MASS", "mlogit", "nnet", "betareg",
      "mvProbit", "miscTools"
    ))

## Citation

The citation information for this package can be obtained easily when you run `citation("Dyn4cast")` in your `R` console.

    To cite package 'Dyn4cast' in publications use:

      Nmadu J (????). _Dyn4cast: Dynamic Modeling and Machine Learning
      Environment_. R package version 11.11.26,
      <https://github.com/JobNmadu/Dyn4cast>.

    A BibTeX entry for LaTeX users is

      @Manual{,
        title = {Dyn4cast: Dynamic Modeling and Machine Learning Environment},
        author = {Job Nmadu},
        note = {R package version 11.11.26},
        url = {https://github.com/JobNmadu/Dyn4cast},
      }