From a9f66d4101564284df3ce41f9fddc43736fd6376 Mon Sep 17 00:00:00 2001
From: "Prof. Job N Nmadu" <job.nmadu@gmail.com>
Date: Sat, 8 Jul 2023 08:17:49 +0100
Subject: [PATCH] readme edits

---
 README.Rmd | 30 +++++++++++++++++++++++++++---
 README.md  | 31 ++++++++++++++++++++++++++++---
 2 files changed, 55 insertions(+), 6 deletions(-)

diff --git a/README.Rmd b/README.Rmd
index b736a05..ff85ce9 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -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 
@@ -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
     
diff --git a/README.md b/README.md
index 09cae8c..1e64b4f 100644
--- a/README.md
+++ b/README.md
@@ -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.
@@ -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
@@ -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