adding introductory vignette

UI-Research · Jan 27, 2024 · fde73e5 · fde73e5
1 parent de55c95
commit fde73e5
Show file tree

Hide file tree

Showing 5 changed files with 331 additions and 18 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@
 .Ruserdata
 .DS_Store
 docs
+inst/doc
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -24,6 +24,9 @@ Imports:
     tidyr,
     tigris
 Suggests:
-    ggplot2
+    ggplot2,
+    knitr,
+    rmarkdown
 RoxygenNote: 7.3.1
 URL: https://ui-research.github.io/urbnindicators/
+VignetteBuilder: knitr
diff --git a/renv.lock b/renv.lock
@@ -22,20 +22,20 @@
     },
     "KernSmooth": {
       "Package": "KernSmooth",
-      "Version": "2.23-20",
+      "Version": "2.23-22",
       "Source": "Repository",
-      "Repository": "CRAN",
+      "Repository": "RSPM",
       "Requirements": [
         "R",
         "stats"
       ],
-      "Hash": "8dcfa99b14c296bc9f1fd64d52fd3ce7"
+      "Hash": "2fecebc3047322fa5930f74fae5de70f"
     },
     "MASS": {
       "Package": "MASS",
-      "Version": "7.3-58.4",
+      "Version": "7.3-60.0.1",
       "Source": "Repository",
-      "Repository": "CRAN",
+      "Repository": "RSPM",
       "Requirements": [
         "R",
         "grDevices",
@@ -44,7 +44,7 @@
         "stats",
         "utils"
       ],
-      "Hash": "a3142b2a022b8174ca675bc8b80cdc4e"
+      "Hash": "b765b28387acc8ec9e9c1530713cb19c"
     },
     "R6": {
       "Package": "R6",
@@ -67,6 +67,13 @@
       ],
       "Hash": "5ea2700d21e038ace58269ecdbeb9ec0"
     },
+    "RcppProgress": {
+      "Package": "RcppProgress",
+      "Version": "0.4.2",
+      "Source": "Repository",
+      "Repository": "RSPM",
+      "Hash": "1c0aa18b97e6aaa17f93b8b866c0ace5"
+    },
     "askpass": {
       "Package": "askpass",
       "Version": "1.2.0",
@@ -77,6 +84,16 @@
       ],
       "Hash": "cad6cf7f1d5f6e906700b9d3e718c796"
     },
+    "backports": {
+      "Package": "backports",
+      "Version": "1.4.1",
+      "Source": "Repository",
+      "Repository": "RSPM",
+      "Requirements": [
+        "R"
+      ],
+      "Hash": "c39fbec8a30d23e721980b8afb31984c"
+    },
     "bit": {
       "Package": "bit",
       "Version": "4.0.5",
@@ -101,9 +118,21 @@
       ],
       "Hash": "9fe98599ca456d6552421db0d6772d8f"
     },
+    "checkmate": {
+      "Package": "checkmate",
+      "Version": "2.3.1",
+      "Source": "Repository",
+      "Repository": "RSPM",
+      "Requirements": [
+        "R",
+        "backports",
+        "utils"
+      ],
+      "Hash": "c01cab1cb0f9125211a6fc99d540e315"
+    },
     "class": {
       "Package": "class",
-      "Version": "7.3-21",
+      "Version": "7.3-22",
       "Source": "Repository",
       "Repository": "CRAN",
       "Requirements": [
@@ -112,7 +141,7 @@
         "stats",
         "utils"
       ],
-      "Hash": "8ae0d4328e2eb3a582dfd5391a3663b7"
+      "Hash": "f91f6b29f38b8c280f2b9477787d4bb2"
     },
     "classInt": {
       "Package": "classInt",
@@ -183,6 +212,17 @@
       ],
       "Hash": "ce88d13c0b10fe88a37d9c59dba2d7f9"
     },
+    "data.table": {
+      "Package": "data.table",
+      "Version": "1.14.10",
+      "Source": "Repository",
+      "Repository": "RSPM",
+      "Requirements": [
+        "R",
+        "methods"
+      ],
+      "Hash": "6ea17a32294d8ca00455825ab0cf71b9"
+    },
     "dplyr": {
       "Package": "dplyr",
       "Version": "1.1.4",
@@ -502,6 +542,20 @@
       ],
       "Hash": "32f7b1a15bb01ae809022960abad5363"
     },
+    "segregation": {
+      "Package": "segregation",
+      "Version": "1.1.0",
+      "Source": "Repository",
+      "Repository": "CRAN",
+      "Requirements": [
+        "R",
+        "Rcpp",
+        "RcppProgress",
+        "checkmate",
+        "data.table"
+      ],
+      "Hash": "aad66430ce212005a238598410283699"
+    },
     "selectr": {
       "Package": "selectr",
       "Version": "0.4-2",
@@ -596,9 +650,9 @@
     },
     "tidycensus": {
       "Package": "tidycensus",
-      "Version": "1.5",
+      "Version": "1.6",
       "Source": "Repository",
-      "Repository": "CRAN",
+      "Repository": "RSPM",
       "Requirements": [
         "R",
         "crayon",
@@ -619,13 +673,13 @@
         "utils",
         "xml2"
       ],
-      "Hash": "e744911b8fcffc093aa16f08527101d4"
+      "Hash": "10d1f36623aa1e2e713e314091a309ec"
     },
     "tidyr": {
       "Package": "tidyr",
-      "Version": "1.3.0",
+      "Version": "1.3.1",
       "Source": "Repository",
-      "Repository": "CRAN",
+      "Repository": "RSPM",
       "Requirements": [
         "R",
         "cli",
@@ -642,7 +696,7 @@
         "utils",
         "vctrs"
       ],
-      "Hash": "e47debdc7ce599b070c8e78e8ac0cfcf"
+      "Hash": "915fb7ce036c22a6a33b5a8adb712eb1"
     },
     "tidyselect": {
       "Package": "tidyselect",
@@ -662,9 +716,9 @@
     },
     "tigris": {
       "Package": "tigris",
-      "Version": "2.0.4",
+      "Version": "2.1",
       "Source": "Repository",
-      "Repository": "CRAN",
+      "Repository": "RSPM",
       "Requirements": [
         "R",
         "dplyr",
@@ -677,7 +731,7 @@
         "utils",
         "uuid"
       ],
-      "Hash": "5d5a584639a92e76baa3ed32c7999886"
+      "Hash": "d750d0f06536d915f01d433254451204"
     },
     "tzdb": {
       "Package": "tzdb",

diff --git a/vignettes/.gitignore b/vignettes/.gitignore
@@ -0,0 +1,2 @@
+*.html
+*.R