From 4a2cd9e1dd5442f75129b51ed4c0e006a2671b3d Mon Sep 17 00:00:00 2001 From: Jared Knowles Date: Sun, 16 Oct 2022 19:17:38 -0400 Subject: [PATCH] refresh doco --- DESCRIPTION | 48 +++++++++++++++++++-------------------- man/add_logo.Rd | 3 --- man/add_logo_ga.Rd | 3 --- man/countDots.Rd | 3 --- man/get_png.Rd | 6 ----- man/grade_level_to_num.Rd | 3 --- man/measure_caption.Rd | 2 +- man/race_short_names.Rd | 3 --- 8 files changed, 25 insertions(+), 46 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 75d9eca..9c3efc0 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,24 +1,24 @@ -Package: civilytics -Type: Package -Title: Utilities Functions for Civilytics -Version: 0.1.0 -Author: Jared E. Knowles -Maintainer: Jared E. Knowles -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 +Maintainer: Jared E. Knowles +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 diff --git a/man/add_logo.Rd b/man/add_logo.Rd index a6cbf86..e3e86bc 100644 --- a/man/add_logo.Rd +++ b/man/add_logo.Rd @@ -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 diff --git a/man/add_logo_ga.Rd b/man/add_logo_ga.Rd index 836e99a..79d1157 100644 --- a/man/add_logo_ga.Rd +++ b/man/add_logo_ga.Rd @@ -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 diff --git a/man/countDots.Rd b/man/countDots.Rd index ff6aded..71c99d9 100644 --- a/man/countDots.Rd +++ b/man/countDots.Rd @@ -8,9 +8,6 @@ countDots(x) } \arguments{ \item{x}{a character vector} -} -\value{ - } \description{ Count the number of single period entries in a vector diff --git a/man/get_png.Rd b/man/get_png.Rd index 68e8972..f5edd11 100644 --- a/man/get_png.Rd +++ b/man/get_png.Rd @@ -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{ - -} diff --git a/man/grade_level_to_num.Rd b/man/grade_level_to_num.Rd index 0a2e7d7..fd6a9bc 100644 --- a/man/grade_level_to_num.Rd +++ b/man/grade_level_to_num.Rd @@ -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 diff --git a/man/measure_caption.Rd b/man/measure_caption.Rd index b4a24be..f38d394 100644 --- a/man/measure_caption.Rd +++ b/man/measure_caption.Rd @@ -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 } diff --git a/man/race_short_names.Rd b/man/race_short_names.Rd index f1eebad..c7e5eab 100644 --- a/man/race_short_names.Rd +++ b/man/race_short_names.Rd @@ -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