add package doco skeleton and images

man/add_logo.Rd

@@ -0,0 +1,17 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/logo.R
+\name{add_logo}
+\alias{add_logo}
+\title{Title}
+\usage{
+add_logo(plot, logo, margin_param = NULL)
+}
+\arguments{
+\item{margin_param}{}
+}
+\value{
+
+}
+\description{
+Title
+}

man/add_logo_ga.Rd

@@ -0,0 +1,17 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/logo.R
+\name{add_logo_ga}
+\alias{add_logo_ga}
+\title{Title}
+\usage{
+add_logo_ga(plot_list, logo, nrow = 1, widths = NULL, margin_param = NULL)
+}
+\arguments{
+\item{margin_param}{}
+}
+\value{
+
+}
+\description{
+Title
+}

man/get_png.Rd

@@ -0,0 +1,17 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/logo.R
+\name{get_png}
+\alias{get_png}
+\title{Title}
+\usage{
+get_png(filename)
+}
+\arguments{
+\item{filename}{}
+}
+\value{
+
+}
+\description{
+Title
+}

man/has_caption.Rd

@@ -0,0 +1,17 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/logo.R
+\name{has_caption}
+\alias{has_caption}
+\title{Title}
+\usage{
+has_caption(gg)
+}
+\arguments{
+\item{gg}{}
+}
+\value{
+
+}
+\description{
+Title
+}

man/make_logo_grob.Rd

@@ -0,0 +1,14 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/logo.R
+\name{make_logo_grob}
+\alias{make_logo_grob}
+\title{Get a Civilytics Logo grob}
+\usage{
+make_logo_grob()
+}
+\value{
+
+}
+\description{
+Get a Civilytics Logo grob
+}

man/measure_caption.Rd

@@ -0,0 +1,17 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/logo.R
+\name{measure_caption}
+\alias{measure_caption}
+\title{Title}
+\usage{
+measure_caption(gg)
+}
+\arguments{
+\item{gg}{}
+}
+\value{
+
+}
+\description{
+Title
+}

man/na_zero.Rd

@@ -0,0 +1,21 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/utils.R
+\name{na_zero}
+\alias{na_zero}
+\title{Zero out missing values}
+\usage{
+na_zero(x)
+}
+\arguments{
+\item{x}{a numeric vector with missing values}
+}
+\value{
+a numeric vector with missing values replaced by 0
+}
+\description{
+Zero out missing values
+}
+\examples{
+na_zero(1:10)
+na_zero(c(NA, NA, 2:10))
+}

man/plot_jpeg.Rd

@@ -0,0 +1,20 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/logo.R
+\name{plot_jpeg}
+\alias{plot_jpeg}
+\title{Title}
+\usage{
+plot_jpeg(path, add = FALSE, upscale = TRUE)
+}
+\arguments{
+\item{upscale}{}
+}
+\value{
+
+}
+\description{
+Title
+}
+\examples{
+img <- readJPEG(system.file("img","Rlogo.jpg",package="jpeg"))
+}

man/pretty_count.Rd

@@ -0,0 +1,24 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/utils.R
+\name{pretty_count}
+\alias{pretty_count}
+\title{Prettify count data
+Make integers propertly formatted as strings which include commas suitable for printing}
+\usage{
+pretty_count(x)
+}
+\arguments{
+\item{x}{a numeric vector}
+}
+\value{
+a character vector with commas introduced in place positions in the numbers
+}
+\description{
+Prettify count data
+Make integers propertly formatted as strings which include commas suitable for printing
+}
+\examples{
+pretty_count(10)
+pretty_count(1000)
+pretty_count(1e8)
+}

man/pretty_per.Rd

@@ -0,0 +1,25 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/utils.R
+\name{pretty_per}
+\alias{pretty_per}
+\title{Prettify proportion data
+Make data expresed as proportions print out as prettily formatted characters with percentages}
+\usage{
+pretty_per(x, ndigit = 1)
+}
+\arguments{
+\item{x}{a numeric vector of proportions to convert to percentages}
+
+\item{ndigit}{a vector of length 1 indicating the number of digits to display in the percent}
+}
+\value{
+
+}
+\description{
+Prettify proportion data
+Make data expresed as proportions print out as prettily formatted characters with percentages
+}
+\examples{
+pretty_per(0.2, ndigit = 1)
+pretty_per(c(0.2, 0.332423, 0.4, 0.342342), ndigit = 2)
+}

man/safe_max.Rd

@@ -0,0 +1,23 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/utils.R
+\name{safe_max}
+\alias{safe_max}
+\title{Safe maximum
+Take the max but ignore missing values}
+\usage{
+safe_max(x)
+}
+\arguments{
+\item{x}{a numeric vector which may contain NA values}
+}
+\value{
+the maximum non-missing value
+}
+\description{
+Safe maximum
+Take the max but ignore missing values
+}
+\examples{
+safe_max(1:10)
+safe_max(c(1:10, NA)) # 10
+}

man/theme_civilytics.Rd

@@ -0,0 +1,24 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/theme.R
+\name{theme_civilytics}
+\alias{theme_civilytics}
+\title{Title}
+\usage{
+theme_civilytics(
+  font_size = 14,
+  font_family = "",
+  line_size = 0.5,
+  rel_small = 12/14,
+  rel_tiny = 11/14,
+  rel_large = 16/14
+)
+}
+\arguments{
+\item{rel_large}{}
+}
+\value{
+
+}
+\description{
+Title
+}