Skip to content

Commit

Permalink
Added Readme documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
koolgax99 committed Jun 29, 2023
1 parent 28c1a1e commit f48f09e
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions shiny/NewForecastingDashboard/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# New Forecasting Dashboard

To use the application please follow the following steps

## 1. Load the data
The data can be loaded by using the `load()` function and mentioning the .rda file. Change the path depending on your path.
```
load("~/pecan/shiny/NewForecastingDashboard/data/data.rda")
```

## 2. Load the package
Run the following command after setting your working directory to the `NewForecastingDashboard` path.
```
load_all()
```

## 3. Using the app
Run The following command in your console to run the shiny app after loading the package.
```
NewForecastingDashboardApp()
```

0 comments on commit f48f09e

Please sign in to comment.