.

pedrocava · Jan 13, 2019 · aa17be0 · aa17be0
1 parent 0810526
commit aa17be0
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 1 deletion.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -1,2 +1,4 @@
+^Meta$
+^doc$
 ^.*\.Rproj$
 ^\.Rproj\.user$
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
+Meta
+doc
 .Rproj.user
 .Rhistory
 .RData
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -18,3 +18,5 @@ LazyData: true
 RoxygenNote: 6.1.1
 Imports: rootSolve,
           stats
+Suggests: knitr, rmarkdown, plot3D, dplyr
+VignetteBuilder: knitr
diff --git a/R/grid_2.R b/R/grid_2.R
@@ -6,7 +6,7 @@
 #' @param c is the "by" parameter, the grid's density. Defaults to .5.
 #' @export
 
-grid.2 <- function(a = 0,
+grid2 <- function(a = 0,
                    b = 100,
                    c = .5) {
 

diff --git a/vignettes/vignette.Rmd b/vignettes/vignette.Rmd
@@ -0,0 +1,20 @@
+---
+title: "Recon: Canonical Economic Models in R"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{Recon: Canonical Economic Models in R}
+  %\VignetteEngine{knitr::rmarkdown}
+  \usepackage[utf8]{inputenc}
+---
+
+``Recon`` is all about making computing and exploring economic models easier. It is meant as a teaching tool for professors and as a way to deeper the understanding of undergrads. 
+
+Here, as an example, we'll use functions ``grid2()`` and ``cobb_douglas_2()`` in combination with ploting tools from the package ``plot3D`` to visualize utility levels and indiference curves.
+
+```{R}
+library(Recon)
+library(plot3D)
+
+consumption_set = grid2()
+
+```