refresh doco

2022-10-16 19:17:38 -04:00
parent f50290ba40
commit 4a2cd9e1dd
8 changed files with 25 additions and 46 deletions
@@ -1,24 +1,24 @@
-Package: civilytics
-Type: Package
-Title: Utilities Functions for Civilytics
-Version: 0.1.0
-Author: Jared E. Knowles <jared@civilytics.com>
-Maintainer: Jared E. Knowles <jared@civilytics.com>
-Description: House R functions for Civilytics Consulting LLC
-    This package implements a variety of useful functions for creating and 
-    branding analyses produced by Civilytics Consulting LLC. 
-License: LICENSE
-Depends:
-    R (>= 2.15.1)
-Imports:
-    ggplot2,
-    jpeg,
-    png,
-    stringr,
-    gridExtra,
-    grid
-Encoding: UTF-8
-LazyData: true
-Suggests: 
-    testthat
-RoxygenNote: 7.1.1
+Package: civilytics
+Type: Package
+Title: Utilities Functions for Civilytics
+Version: 0.1.0
+Author: Jared E. Knowles <jared@civilytics.com>
+Maintainer: Jared E. Knowles <jared@civilytics.com>
+Description: House R functions for Civilytics Consulting LLC
+    This package implements a variety of useful functions for creating and 
+    branding analyses produced by Civilytics Consulting LLC. 
+License: LICENSE
+Depends:
+    R (>= 2.15.1)
+Imports:
+    ggplot2,
+    jpeg,
+    png,
+    stringr,
+    gridExtra,
+    grid
+Encoding: UTF-8
+LazyData: true
+Suggests: 
+    testthat
+RoxygenNote: 7.2.1
@@ -12,9 +12,6 @@ add_logo(plot, logo, margin_param = NULL)
 \item{logo}{a logo grob created by make_logo_grob()}

 \item{margin_param}{a numeric specifying what margin to add or subtract to align the logo}
-}
-\value{
-
 }
 \description{
 Add a logo to a ggplot2 object
@@ -16,9 +16,6 @@ add_logo_ga(plot_list, logo, nrow = 1, widths = NULL, margin_param = NULL)
 \item{widths}{an optional vector the same length as plot_list with the widths for each plot}

 \item{margin_param}{a number giving the adjustment up or down to help manually align logo and captions}
-}
-\value{
-
 }
 \description{
 Add a logo to a ggplot2 object
@@ -8,9 +8,6 @@ countDots(x)
 }
 \arguments{
 \item{x}{a character vector}
-}
-\value{
-
 }
 \description{
 Count the number of single period entries in a vector
@@ -8,13 +8,7 @@ get_png(filename)
 }
 \arguments{
 \item{filename}{a character with file path to a png file}
-}
-\value{
-
 }
 \description{
 Plot a PNG file as a rasterGrob for inclusion in ggplot2
 }
-\examples{
-
-}
@@ -8,9 +8,6 @@ grade_level_to_num(x)
 }
 \arguments{
 \item{x}{character description of grade levels from NCES style data}
-}
-\value{
-
 }
 \description{
 Recode grade level from character to numeric
@@ -17,6 +17,6 @@ the caption
 Measure a ggplot2 object caption
 }
 \examples{
-p1 <- qplot(mpg, wt, data = mtcars)
+p1 <- ggplot2::qplot(mpg, wt, data = mtcars)
 measure_caption(p1) # Should equal 1 since no caption is required
 }
@@ -8,9 +8,6 @@ race_short_names(x)
 }
 \arguments{
 \item{x}{a character vector with NCES race codes, often from Urban Institute}
-}
-\value{
-
 }
 \description{
 Recode NCES race categories to shorter names