cleanup tests and build

man/add_logo.Rd

@@ -13,6 +13,9 @@ add_logo(plot, logo, margin_param = NULL)
 
 \item{margin_param}{a numeric specifying what margin to add or subtract to align the logo}
 }
+\value{
+a grob with a logo attached to it ready to plot
+}
 \description{
 Add a logo to a ggplot2 object
 }

man/add_logo_ga.Rd

@@ -17,6 +17,9 @@ add_logo_ga(plot_list, logo, nrow = 1, widths = NULL, margin_param = NULL)
 
 \item{margin_param}{a number giving the adjustment up or down to help manually align logo and captions}
 }
+\value{
+a grid object
+}
 \description{
 Add a logo to a ggplot2 object
 }

man/countDots.Rd

@@ -9,6 +9,9 @@ countDots(x)
 \arguments{
 \item{x}{a character vector}
 }
+\value{
+An integer counting the number of "." occurences in a vector
+}
 \description{
 Count the number of single period entries in a vector
 }

man/get_png.Rd

@@ -9,6 +9,9 @@ get_png(filename)
 \arguments{
 \item{filename}{a character with file path to a png file}
 }
+\value{
+a plotted rasteGrob of a png image
+}
 \description{
 Plot a PNG file as a rasterGrob for inclusion in ggplot2
 }

man/grade_level_to_num.Rd

@@ -9,6 +9,12 @@ grade_level_to_num(x)
 \arguments{
 \item{x}{character description of grade levels from NCES style data}
 }
+\value{
+a numeric vector
+}
 \description{
 Recode grade level from character to numeric
 }
+\examples{
+grade_level_to_num(c("KG", "Pre-K", "12", "10", "09"))
+}

man/plot_jpeg.Rd

@@ -21,6 +21,6 @@ a rasterImage
 Plot a jpeg image as a raster
 }
 \examples{
-img <- system.file("img","Civilytics Consulting Logo.jpg",package="civilytics")
+img <- system.file("img","civilytics_logo.jpg",package="civilytics")
 plot_jpeg(img)
 }

man/race_short_names.Rd

@@ -9,6 +9,12 @@ race_short_names(x)
 \arguments{
 \item{x}{a character vector with NCES race codes, often from Urban Institute}
 }
+\value{
+recoded race categories following NCES race codes
+}
 \description{
 Recode NCES race categories to shorter names
 }
+\examples{
+race_short_names(c("Black", "Hispanic Or Latino", "Two Or More Races"))
+}

man/star_subs.Rd

@@ -7,6 +7,8 @@
 star_subs(x, replace_char = "*", zeros = 15, max_value = 20)
 }
 \arguments{
+\item{x}{a vector}
+
 \item{replace_char}{the character you want to replace in the vector}
 
 \item{zeros}{the number of zeroes to oversample when replacing replace_char}