Skip to content

Commit

Permalink
readme edits
Browse files Browse the repository at this point in the history
  • Loading branch information
JobNmadu committed Jul 8, 2023
1 parent ac623b1 commit a9f66d4
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 6 deletions.
30 changes: 27 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ At present, the package exports the following functions:

8. `data_transform` is a wrapper for standardizing `data.frame` to make the values comparable for estimation and/or visualization.

8. `estimate_plot` is a function for plotting estimated coefficients of a model in their order of significance.

8. `corplot` is for plotting the correlation matrix.

## Things the package can do

The package is capable of
Expand Down Expand Up @@ -109,25 +113,45 @@ The package is capable of

* Inverse scaled logit for constrained forecast

* Linear regression and transformations which consists of
* Linear regression and functional forms which consists of

+ Linear model

+ Linear model with interactions

+ Semilog model

+ Growth model

+ Double Log model

+ Mixed-power model

+ Translog model

+ Quadratic model

+ Cubic model

+ Inverse of y model

+ Square root of y model
+ Inverse of x model

+ Inverse of y & x model

+ Square root of model

+ Cubic root of model

+ formatted Model Table

+ Prediction plots
+ Prediction plots

+ Fitted plots

+ Naive effects plots

+ Coefficients importance plot

+ Summary of numeric variables

Expand Down
31 changes: 28 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ At present, the package exports the following functions:
any recognized format but should be a **dataframe** containing two
columns `Date` and `Case`. The Date is the *day/month/year* the data
is collected while Case is the variable for forecasting. The Date
must be in the recognized format, i.e., **YYYY-MM-DD**. The other
must be in the recognized format i.e. ‘YYYY-MM-DD. The other
arguments parsed to the function are `MaximumDate`, which is the
last date Data was collected and `BREAKS`, which is a vector of
numbers and is used as `knots` in estimating spline polynomials.
Expand Down Expand Up @@ -86,6 +86,11 @@ At present, the package exports the following functions:
9. `data_transform` is a wrapper for standardizing `data.frame` to make
the values comparable for estimation and/or visualization.

10. `estimate_plot` is a function for plotting estimated coefficients of
a model in their order of significance.

11. `corplot` is for plotting the correlation matrix.

## Things the package can do

The package is capable of
Expand Down Expand Up @@ -129,26 +134,46 @@ The package is capable of

- Inverse scaled logit for constrained forecast

- Linear regression and transformations which consists of
- Linear regression and functional forms which consists of

- Linear model

- Linear model with interactions

- Semilog model

- Growth model

- Double Log model

- Mixed-power model

- Translog model

- Quadratic model

- Cubic model

- Inverse of y model

- Square root of y model
- Inverse of x model

- Inverse of y & x model

- Square root of model

- Cubic root of model

- formatted Model Table

- Prediction plots

- Fitted plots

- Naive effects plots

- Coefficients importance plot

- Summary of numeric variables

- Summary of character variables
Expand Down

0 comments on commit a9f66d4

Please sign in to comment.