add package doco skeleton and images

2020-02-13 17:09:03 -05:00
parent 1f41a4560d
commit f5f288974f
30 changed files with 1071 additions and 13 deletions
@@ -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)
+}