fix proportion ci calc and theme
Gitea Organization/civilyticsR/pipeline/head There was a failure building this commit
Gitea Organization/civilyticsR/pipeline/head There was a failure building this commit
This commit is contained in:
+27
-27
@@ -1,27 +1,27 @@
|
||||
# [Choice] R version: 4, 4.2, 4.1, 4.0
|
||||
ARG VARIANT=4.2
|
||||
# [Choice] Base image. Minimal (r-ver), tidyverse installed (tidyverse), or full image (binder): rocker/r-ver, rocker/tidyverse, rocker/binder
|
||||
ARG BASE_IMAGE=rocker/r-ver
|
||||
FROM ${BASE_IMAGE}:${VARIANT}
|
||||
|
||||
|
||||
RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||
sudo \
|
||||
libcurl4-gnutls-dev \
|
||||
libxml2-dev \
|
||||
libcairo2-dev \
|
||||
libxt-dev \
|
||||
libjpeg-dev \
|
||||
libpng-dev \
|
||||
openjdk-11-jdk \
|
||||
libssl-dev \
|
||||
libssh2-1-dev \
|
||||
libudunits2-dev \
|
||||
libgdal-dev \
|
||||
libgeos-dev \
|
||||
libproj-dev \
|
||||
&& rm -rf /var/lib/apt/lists/* \
|
||||
&& mkdir -p /var/lib/shiny-server/bookmarks/shiny
|
||||
|
||||
|
||||
RUN install2.r ggplot2 jpeg png stringr gridExtra grid testthat covr tidycensus stringdist
|
||||
# [Choice] R version: 4, 4.2, 4.1, 4.0
|
||||
ARG VARIANT=4.2
|
||||
# [Choice] Base image. Minimal (r-ver), tidyverse installed (tidyverse), or full image (binder): rocker/r-ver, rocker/tidyverse, rocker/binder
|
||||
ARG BASE_IMAGE=rocker/r-ver
|
||||
FROM ${BASE_IMAGE}:${VARIANT}
|
||||
|
||||
|
||||
RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||
sudo \
|
||||
libcurl4-gnutls-dev \
|
||||
libxml2-dev \
|
||||
libcairo2-dev \
|
||||
libxt-dev \
|
||||
libjpeg-dev \
|
||||
libpng-dev \
|
||||
openjdk-11-jdk \
|
||||
libssl-dev \
|
||||
libssh2-1-dev \
|
||||
libudunits2-dev \
|
||||
libgdal-dev \
|
||||
libgeos-dev \
|
||||
libproj-dev \
|
||||
&& rm -rf /var/lib/apt/lists/* \
|
||||
&& mkdir -p /var/lib/shiny-server/bookmarks/shiny
|
||||
|
||||
|
||||
RUN install2.r ggplot2 jpeg png stringr gridExtra grid testthat covr tidycensus stringdist
|
||||
|
||||
Vendored
+60
-60
@@ -1,60 +1,60 @@
|
||||
pipeline {
|
||||
agent {
|
||||
dockerfile true
|
||||
}
|
||||
stages {
|
||||
stage('Docker setup') {
|
||||
steps {
|
||||
sh '''
|
||||
R --version
|
||||
java --version
|
||||
'''
|
||||
}
|
||||
|
||||
}
|
||||
stage('Build and test') {
|
||||
stages {
|
||||
stage("Build package") {
|
||||
steps {
|
||||
sh '''
|
||||
R CMD build .
|
||||
'''
|
||||
}
|
||||
}
|
||||
stage('Check') {
|
||||
steps {
|
||||
sh '''
|
||||
R CMD check --no-manual civilytics_0.1.0.tar.gz
|
||||
'''
|
||||
|
||||
sh '''
|
||||
R CMD INSTALL civilytics_0.1.0.tar.gz
|
||||
'''
|
||||
}
|
||||
}
|
||||
stage('testthat'){
|
||||
steps {
|
||||
sh '''
|
||||
R -e 'testthat::test_local(".")'
|
||||
'''
|
||||
}
|
||||
}
|
||||
stage('test coverage') {
|
||||
steps {
|
||||
sh '''
|
||||
R -e 'covr::package_coverage(".")'
|
||||
'''
|
||||
}
|
||||
}
|
||||
stage('Clean') {
|
||||
steps {
|
||||
|
||||
sh '''
|
||||
rm -rf civilytics_0.1.0.tar.gz civilytics.Rcheck
|
||||
'''
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
pipeline {
|
||||
agent {
|
||||
dockerfile true
|
||||
}
|
||||
stages {
|
||||
stage('Docker setup') {
|
||||
steps {
|
||||
sh '''
|
||||
R --version
|
||||
java --version
|
||||
'''
|
||||
}
|
||||
|
||||
}
|
||||
stage('Build and test') {
|
||||
stages {
|
||||
stage("Build package") {
|
||||
steps {
|
||||
sh '''
|
||||
R CMD build .
|
||||
'''
|
||||
}
|
||||
}
|
||||
stage('Check') {
|
||||
steps {
|
||||
sh '''
|
||||
R CMD check --no-manual civilytics_0.1.0.tar.gz
|
||||
'''
|
||||
|
||||
sh '''
|
||||
R CMD INSTALL civilytics_0.1.0.tar.gz
|
||||
'''
|
||||
}
|
||||
}
|
||||
stage('testthat'){
|
||||
steps {
|
||||
sh '''
|
||||
R -e 'testthat::test_local(".")'
|
||||
'''
|
||||
}
|
||||
}
|
||||
stage('test coverage') {
|
||||
steps {
|
||||
sh '''
|
||||
R -e 'covr::package_coverage(".")'
|
||||
'''
|
||||
}
|
||||
}
|
||||
stage('Clean') {
|
||||
steps {
|
||||
|
||||
sh '''
|
||||
rm -rf civilytics_0.1.0.tar.gz civilytics.Rcheck
|
||||
'''
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,26 +1,26 @@
|
||||
# h/t to @jimhester and @yihui for this parse block:
|
||||
# https://github.com/yihui/knitr/blob/dc5ead7bcfc0ebd2789fe99c527c7d91afb3de4a/Makefile#L1-L4
|
||||
# Note the portability change as suggested in the manual:
|
||||
# https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Writing-portable-packages
|
||||
PKGNAME = `sed -n "s/Package: *\([^ ]*\)/\1/p" DESCRIPTION`
|
||||
PKGVERS = `sed -n "s/Version: *\([^ ]*\)/\1/p" DESCRIPTION`
|
||||
|
||||
|
||||
all: check
|
||||
|
||||
build: install_deps
|
||||
R CMD build .
|
||||
|
||||
check: build
|
||||
R CMD check --no-manual $(PKGNAME)_$(PKGVERS).tar.gz
|
||||
|
||||
install_deps:
|
||||
Rscript \
|
||||
-e 'if (!requireNamespace("remotes")) install.packages("remotes")' \
|
||||
-e 'remotes::install_deps(dependencies = TRUE)'
|
||||
|
||||
install: build
|
||||
R CMD INSTALL $(PKGNAME)_$(PKGVERS).tar.gz
|
||||
|
||||
clean:
|
||||
@rm -rf $(PKGNAME)_$(PKGVERS).tar.gz $(PKGNAME).Rcheck
|
||||
# h/t to @jimhester and @yihui for this parse block:
|
||||
# https://github.com/yihui/knitr/blob/dc5ead7bcfc0ebd2789fe99c527c7d91afb3de4a/Makefile#L1-L4
|
||||
# Note the portability change as suggested in the manual:
|
||||
# https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Writing-portable-packages
|
||||
PKGNAME = `sed -n "s/Package: *\([^ ]*\)/\1/p" DESCRIPTION`
|
||||
PKGVERS = `sed -n "s/Version: *\([^ ]*\)/\1/p" DESCRIPTION`
|
||||
|
||||
|
||||
all: check
|
||||
|
||||
build: install_deps
|
||||
R CMD build .
|
||||
|
||||
check: build
|
||||
R CMD check --no-manual $(PKGNAME)_$(PKGVERS).tar.gz
|
||||
|
||||
install_deps:
|
||||
Rscript \
|
||||
-e 'if (!requireNamespace("remotes")) install.packages("remotes")' \
|
||||
-e 'remotes::install_deps(dependencies = TRUE)'
|
||||
|
||||
install: build
|
||||
R CMD INSTALL $(PKGNAME)_$(PKGVERS).tar.gz
|
||||
|
||||
clean:
|
||||
@rm -rf $(PKGNAME)_$(PKGVERS).tar.gz $(PKGNAME).Rcheck
|
||||
|
||||
@@ -1,48 +1,48 @@
|
||||
# Generated by roxygen2: do not edit by hand
|
||||
|
||||
export(add_logo)
|
||||
export(add_logo_ga)
|
||||
export(countCleanr)
|
||||
export(countDots)
|
||||
export(countNA)
|
||||
export(dbSafeNames)
|
||||
export(findDots)
|
||||
export(get_fips)
|
||||
export(get_png)
|
||||
export(get_stabbr)
|
||||
export(grade_level_to_num)
|
||||
export(has_caption)
|
||||
export(make_logo_grob)
|
||||
export(match_test)
|
||||
export(measure_caption)
|
||||
export(na_sum)
|
||||
export(na_zero)
|
||||
export(nvals)
|
||||
export(outersect)
|
||||
export(perturb_count)
|
||||
export(plot_jpeg)
|
||||
export(postcode_lookup)
|
||||
export(pretty_count)
|
||||
export(pretty_per)
|
||||
export(race_short_names)
|
||||
export(random_round)
|
||||
export(safe_max)
|
||||
export(safe_ratio)
|
||||
export(simpleCap)
|
||||
export(star_subs)
|
||||
export(theme_civilytics)
|
||||
export(z_gap_test)
|
||||
export(z_univariate)
|
||||
import(ggplot2)
|
||||
import(tidycensus)
|
||||
importFrom(ggplot2,theme)
|
||||
importFrom(graphics,plot)
|
||||
importFrom(graphics,rasterImage)
|
||||
importFrom(grid,grid.draw)
|
||||
importFrom(grid,rasterGrob)
|
||||
importFrom(gridExtra,arrangeGrob)
|
||||
importFrom(jpeg,readJPEG)
|
||||
importFrom(png,readPNG)
|
||||
importFrom(stats,runif)
|
||||
importFrom(stringdist,stringsim)
|
||||
importFrom(stringr,str_count)
|
||||
# Generated by roxygen2: do not edit by hand
|
||||
|
||||
export(add_logo)
|
||||
export(add_logo_ga)
|
||||
export(countCleanr)
|
||||
export(countDots)
|
||||
export(countNA)
|
||||
export(dbSafeNames)
|
||||
export(findDots)
|
||||
export(get_fips)
|
||||
export(get_png)
|
||||
export(get_stabbr)
|
||||
export(grade_level_to_num)
|
||||
export(has_caption)
|
||||
export(make_logo_grob)
|
||||
export(match_test)
|
||||
export(measure_caption)
|
||||
export(na_sum)
|
||||
export(na_zero)
|
||||
export(nvals)
|
||||
export(outersect)
|
||||
export(perturb_count)
|
||||
export(plot_jpeg)
|
||||
export(postcode_lookup)
|
||||
export(pretty_count)
|
||||
export(pretty_per)
|
||||
export(race_short_names)
|
||||
export(random_round)
|
||||
export(safe_max)
|
||||
export(safe_ratio)
|
||||
export(simpleCap)
|
||||
export(star_subs)
|
||||
export(theme_civilytics)
|
||||
export(z_gap_test)
|
||||
export(z_univariate)
|
||||
import(ggplot2)
|
||||
import(tidycensus)
|
||||
importFrom(ggplot2,theme)
|
||||
importFrom(graphics,plot)
|
||||
importFrom(graphics,rasterImage)
|
||||
importFrom(grid,grid.draw)
|
||||
importFrom(grid,rasterGrob)
|
||||
importFrom(gridExtra,arrangeGrob)
|
||||
importFrom(jpeg,readJPEG)
|
||||
importFrom(png,readPNG)
|
||||
importFrom(stats,runif)
|
||||
importFrom(stringdist,stringsim)
|
||||
importFrom(stringr,str_count)
|
||||
|
||||
+48
-48
@@ -1,48 +1,48 @@
|
||||
# Join utilities
|
||||
#' Test the join between two sets of identifiers
|
||||
#'
|
||||
#' @param x a vector of identifiers to check against y
|
||||
#' @param y a vector of identifiers to check against x
|
||||
#' @param distinct logical, should duplicate values of x and y be removed before testing
|
||||
#'
|
||||
#' @return nothing, print a summary of match statistics to the console
|
||||
#' @export
|
||||
#'
|
||||
#' @examples
|
||||
#' x <- LETTERS
|
||||
#' y <- c(letters, LETTERS)
|
||||
#' match_test(x, y)
|
||||
match_test <- function(x, y, distinct = TRUE) {
|
||||
if (distinct) {
|
||||
x <- unique(x)
|
||||
y <- unique(y)
|
||||
cat("**** Distinct Matches ****")
|
||||
cat("\n")
|
||||
|
||||
}
|
||||
|
||||
# TODO: DO not report 100% if there is even 1 mismatch
|
||||
|
||||
xiny <- sum(x %in% y)
|
||||
total_x <- length(x)
|
||||
|
||||
yinx <- sum(y %in% x)
|
||||
total_y <- length(y)
|
||||
|
||||
cat("**** Match Summary ****")
|
||||
cat("\n")
|
||||
cat("X in Y")
|
||||
cat("\n")
|
||||
cat(paste0("Of the ", total_x, " X values, ", xiny, " (",
|
||||
100*round(xiny/total_x, 2), "%) were matched."))
|
||||
cat("\n")
|
||||
cat("********************************************")
|
||||
cat("\n")
|
||||
cat("Y in X")
|
||||
cat("\n")
|
||||
cat(paste0("Of the ", total_y, " Y values, ", yinx, " (",
|
||||
100*round(yinx/total_y, 2), "%) were matched."))
|
||||
cat("\n")
|
||||
cat("******************************************")
|
||||
|
||||
}
|
||||
# Join utilities
|
||||
#' Test the join between two sets of identifiers
|
||||
#'
|
||||
#' @param x a vector of identifiers to check against y
|
||||
#' @param y a vector of identifiers to check against x
|
||||
#' @param distinct logical, should duplicate values of x and y be removed before testing
|
||||
#'
|
||||
#' @return nothing, print a summary of match statistics to the console
|
||||
#' @export
|
||||
#'
|
||||
#' @examples
|
||||
#' x <- LETTERS
|
||||
#' y <- c(letters, LETTERS)
|
||||
#' match_test(x, y)
|
||||
match_test <- function(x, y, distinct = TRUE) {
|
||||
if (distinct) {
|
||||
x <- unique(x)
|
||||
y <- unique(y)
|
||||
cat("**** Distinct Matches ****")
|
||||
cat("\n")
|
||||
|
||||
}
|
||||
|
||||
# TODO: DO not report 100% if there is even 1 mismatch
|
||||
|
||||
xiny <- sum(x %in% y)
|
||||
total_x <- length(x)
|
||||
|
||||
yinx <- sum(y %in% x)
|
||||
total_y <- length(y)
|
||||
|
||||
cat("**** Match Summary ****")
|
||||
cat("\n")
|
||||
cat("X in Y")
|
||||
cat("\n")
|
||||
cat(paste0("Of the ", total_x, " X values, ", xiny, " (",
|
||||
100*round(xiny/total_x, 2), "%) were matched."))
|
||||
cat("\n")
|
||||
cat("********************************************")
|
||||
cat("\n")
|
||||
cat("Y in X")
|
||||
cat("\n")
|
||||
cat(paste0("Of the ", total_y, " Y values, ", yinx, " (",
|
||||
100*round(yinx/total_y, 2), "%) were matched."))
|
||||
cat("\n")
|
||||
cat("******************************************")
|
||||
|
||||
}
|
||||
|
||||
@@ -0,0 +1,70 @@
|
||||
|
||||
|
||||
# https://github.com/cran/binom/blob/master/R/binom.confint.R
|
||||
# Consider importing and crediting this code ^^
|
||||
# https://towardsdatascience.com/five-confidence-intervals-for-proportions-that-you-should-know-about-7ff5484c024f
|
||||
# https://andrewpwheeler.com/2020/11/30/confidence-intervals-around-proportions/
|
||||
#' Get a simple Clopper Pearson interval
|
||||
#'
|
||||
#' @param num
|
||||
#' @param den
|
||||
#' @param confint
|
||||
#'
|
||||
#' @return
|
||||
#' @export
|
||||
#'
|
||||
#' @examples
|
||||
clopper_pearson <- function(num, den, confint = 0.95) {
|
||||
# Same results as binom.test in base R
|
||||
quant <- (1 - confint) / 2
|
||||
low <- qbeta(quant, num, den-num+1)
|
||||
hi <- qbeta(1-quant, num+1, den-num)
|
||||
obs <- num/den
|
||||
return(c("low" = low, "observed" = obs,"high" = hi))
|
||||
}
|
||||
|
||||
|
||||
# TODO consider making a vectorized version
|
||||
# z_gap_test_v <- Vectorize(z_gap_test,
|
||||
# SIMPLIFY = TRUE)# we only want to return a scalar
|
||||
|
||||
|
||||
#z_gap_test(a_prop = 0.051, a_count = 2000, b_prop = 0.11, b_count = 100)
|
||||
|
||||
|
||||
#' Calculate a univariate z score by comparing to a population
|
||||
#'
|
||||
#' @param unit_prop proportion for the group we are comparing
|
||||
#' @param global_prop the global proportion
|
||||
#' @param unit_denom the population size for the group we are comparing
|
||||
#'
|
||||
#' @return a z-score
|
||||
#' @export
|
||||
#'
|
||||
#' @examples
|
||||
#' z_univariate(unit_prop = 0.13, global_prop = 0.11, unit_denom = 2500)
|
||||
z_univariate <- function(unit_prop, global_prop, unit_denom) {
|
||||
num <- unit_prop - global_prop
|
||||
denom <- sqrt(
|
||||
(global_prop * (1-global_prop))/unit_denom
|
||||
)
|
||||
z = num / denom
|
||||
return(z)
|
||||
|
||||
}
|
||||
|
||||
waldInterval <- function(x, n, conf.level = 0.95){
|
||||
p <- x/n
|
||||
sd <- sqrt(p*((1-p)/n))
|
||||
z <- qnorm(c( (1 - conf.level)/2, 1 - (1-conf.level)/2)) #returns the value of thresholds at which conf.level has to be cut at. for 95% CI, this is -1.96 and +1.96
|
||||
ci <- p + z*sd
|
||||
names(ci) <- c('lwr', 'upr')
|
||||
return(ci)
|
||||
}#example
|
||||
#waldInterval(x = 20, n =40) #this will return 0.345 and 0.655
|
||||
|
||||
agresti_coull_interval <- function(num, den, conf.level) {
|
||||
num <- num + 2
|
||||
den <- den + 4
|
||||
|
||||
}
|
||||
@@ -22,14 +22,14 @@ theme_civilytics <-
|
||||
theme(
|
||||
line = element_line(
|
||||
color = "black",
|
||||
size = line_size,
|
||||
linewidth = line_size,
|
||||
linetype = 1,
|
||||
lineend = "butt"
|
||||
),
|
||||
rect = element_rect(
|
||||
fill = NA,
|
||||
color = NA,
|
||||
size = line_size,
|
||||
linewidth = line_size,
|
||||
linetype = 1
|
||||
),
|
||||
text = element_text(
|
||||
@@ -46,7 +46,7 @@ theme_civilytics <-
|
||||
),
|
||||
axis.line = element_line(
|
||||
color = "black",
|
||||
size = line_size,
|
||||
linewidth = line_size,
|
||||
lineend = "square"
|
||||
),
|
||||
axis.line.x = NULL,
|
||||
@@ -62,7 +62,7 @@ theme_civilytics <-
|
||||
axis.text.y.right = element_text(margin = margin(l = small_size / 4),
|
||||
hjust = 0),
|
||||
axis.ticks = element_line(color = "black",
|
||||
size = line_size),
|
||||
linewidth = line_size),
|
||||
axis.ticks.length = unit(half_line / 2,
|
||||
"pt"),
|
||||
axis.title.x = element_text(margin = margin(t = half_line / 2),
|
||||
|
||||
@@ -308,35 +308,8 @@ z_gap_test <- function(a_prop, a_count, b_prop, b_count) {
|
||||
return(z)
|
||||
}
|
||||
|
||||
# TODO consider making a vectorized version
|
||||
# z_gap_test_v <- Vectorize(z_gap_test,
|
||||
# SIMPLIFY = TRUE)# we only want to return a scalar
|
||||
|
||||
|
||||
#z_gap_test(a_prop = 0.051, a_count = 2000, b_prop = 0.11, b_count = 100)
|
||||
|
||||
|
||||
#' Calculate a univariate z score by comparing to a population
|
||||
#'
|
||||
#' @param unit_prop proportion for the group we are comparing
|
||||
#' @param global_prop the global proportion
|
||||
#' @param unit_denom the population size for the group we are comparing
|
||||
#'
|
||||
#' @return a z-score
|
||||
#' @export
|
||||
#'
|
||||
#' @examples
|
||||
#' z_univariate(unit_prop = 0.13, global_prop = 0.11, unit_denom = 2500)
|
||||
z_univariate <- function(unit_prop, global_prop, unit_denom) {
|
||||
num <- unit_prop - global_prop
|
||||
denom <- sqrt(
|
||||
(global_prop * (1-global_prop))/unit_denom
|
||||
)
|
||||
z = num / denom
|
||||
return(z)
|
||||
|
||||
}
|
||||
|
||||
# TODO: Consider vectorizing
|
||||
#z_univariate_v <- Vectorize(z_univariate, SIMPLIFY = TRUE)
|
||||
|
||||
|
||||
+21
-21
@@ -1,21 +1,21 @@
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/logo.R
|
||||
\name{add_logo}
|
||||
\alias{add_logo}
|
||||
\title{Add a logo to a ggplot2 object}
|
||||
\usage{
|
||||
add_logo(plot, logo, margin_param = NULL)
|
||||
}
|
||||
\arguments{
|
||||
\item{plot}{a ggplot2 grob}
|
||||
|
||||
\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{
|
||||
a grob with a logo attached to it ready to plot
|
||||
}
|
||||
\description{
|
||||
Add a logo to a ggplot2 object
|
||||
}
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/logo.R
|
||||
\name{add_logo}
|
||||
\alias{add_logo}
|
||||
\title{Add a logo to a ggplot2 object}
|
||||
\usage{
|
||||
add_logo(plot, logo, margin_param = NULL)
|
||||
}
|
||||
\arguments{
|
||||
\item{plot}{a ggplot2 grob}
|
||||
|
||||
\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{
|
||||
a grob with a logo attached to it ready to plot
|
||||
}
|
||||
\description{
|
||||
Add a logo to a ggplot2 object
|
||||
}
|
||||
|
||||
+36
-36
@@ -1,36 +1,36 @@
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/logo.R
|
||||
\name{add_logo_ga}
|
||||
\alias{add_logo_ga}
|
||||
\title{Add a logo to a ggplot2 object}
|
||||
\usage{
|
||||
add_logo_ga(plot_list, logo, nrow = 1, widths = NULL, margin_param = NULL)
|
||||
}
|
||||
\arguments{
|
||||
\item{plot_list}{a list containing ggplot2 objects}
|
||||
|
||||
\item{logo}{a grob containing the logo created with `make_logo_grob`}
|
||||
|
||||
\item{nrow}{an integer, default = 1, for the number of rows to align the plots in}
|
||||
|
||||
\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{
|
||||
a grid object
|
||||
}
|
||||
\description{
|
||||
Add a logo to a ggplot2 object
|
||||
}
|
||||
\note{
|
||||
The resulting object needs to be drawn to the screen using grid.draw()
|
||||
}
|
||||
\examples{
|
||||
library(ggplot2); library(grid)
|
||||
tmp_plot <- ggplot(mtcars) + aes(x = hp, y = disp) + geom_point() + theme_civilytics()
|
||||
tmp_logo <- make_logo_grob()
|
||||
plot_and_logo <- add_logo(tmp_plot, tmp_logo)
|
||||
grid.draw(plot_and_logo)
|
||||
dev.off()
|
||||
}
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/logo.R
|
||||
\name{add_logo_ga}
|
||||
\alias{add_logo_ga}
|
||||
\title{Add a logo to a ggplot2 object}
|
||||
\usage{
|
||||
add_logo_ga(plot_list, logo, nrow = 1, widths = NULL, margin_param = NULL)
|
||||
}
|
||||
\arguments{
|
||||
\item{plot_list}{a list containing ggplot2 objects}
|
||||
|
||||
\item{logo}{a grob containing the logo created with `make_logo_grob`}
|
||||
|
||||
\item{nrow}{an integer, default = 1, for the number of rows to align the plots in}
|
||||
|
||||
\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{
|
||||
a grid object
|
||||
}
|
||||
\description{
|
||||
Add a logo to a ggplot2 object
|
||||
}
|
||||
\note{
|
||||
The resulting object needs to be drawn to the screen using grid.draw()
|
||||
}
|
||||
\examples{
|
||||
library(ggplot2); library(grid)
|
||||
tmp_plot <- ggplot(mtcars) + aes(x = hp, y = disp) + geom_point() + theme_civilytics()
|
||||
tmp_logo <- make_logo_grob()
|
||||
plot_and_logo <- add_logo(tmp_plot, tmp_logo)
|
||||
grid.draw(plot_and_logo)
|
||||
dev.off()
|
||||
}
|
||||
|
||||
+17
-17
@@ -1,17 +1,17 @@
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/db.R
|
||||
\name{countDots}
|
||||
\alias{countDots}
|
||||
\title{Count the number of single period entries in a vector}
|
||||
\usage{
|
||||
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
|
||||
}
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/db.R
|
||||
\name{countDots}
|
||||
\alias{countDots}
|
||||
\title{Count the number of single period entries in a vector}
|
||||
\usage{
|
||||
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
|
||||
}
|
||||
|
||||
+17
-17
@@ -1,17 +1,17 @@
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/logo.R
|
||||
\name{get_png}
|
||||
\alias{get_png}
|
||||
\title{Plot a PNG file as a rasterGrob for inclusion in ggplot2}
|
||||
\usage{
|
||||
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
|
||||
}
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/logo.R
|
||||
\name{get_png}
|
||||
\alias{get_png}
|
||||
\title{Plot a PNG file as a rasterGrob for inclusion in ggplot2}
|
||||
\usage{
|
||||
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
|
||||
}
|
||||
|
||||
+20
-20
@@ -1,20 +1,20 @@
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/utils.R
|
||||
\name{grade_level_to_num}
|
||||
\alias{grade_level_to_num}
|
||||
\title{Recode grade level from character to numeric}
|
||||
\usage{
|
||||
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"))
|
||||
}
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/utils.R
|
||||
\name{grade_level_to_num}
|
||||
\alias{grade_level_to_num}
|
||||
\title{Recode grade level from character to numeric}
|
||||
\usage{
|
||||
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"))
|
||||
}
|
||||
|
||||
+22
-22
@@ -1,22 +1,22 @@
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/logo.R
|
||||
\name{measure_caption}
|
||||
\alias{measure_caption}
|
||||
\title{Measure a ggplot2 object caption}
|
||||
\usage{
|
||||
measure_caption(gg)
|
||||
}
|
||||
\arguments{
|
||||
\item{gg}{a ggplot object}
|
||||
}
|
||||
\value{
|
||||
a numeric value stating the number of lines to be added or subtracted to align a logo with
|
||||
the caption
|
||||
}
|
||||
\description{
|
||||
Measure a ggplot2 object caption
|
||||
}
|
||||
\examples{
|
||||
p1 <- ggplot2::qplot(mpg, wt, data = mtcars)
|
||||
measure_caption(p1) # Should equal 1 since no caption is required
|
||||
}
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/logo.R
|
||||
\name{measure_caption}
|
||||
\alias{measure_caption}
|
||||
\title{Measure a ggplot2 object caption}
|
||||
\usage{
|
||||
measure_caption(gg)
|
||||
}
|
||||
\arguments{
|
||||
\item{gg}{a ggplot object}
|
||||
}
|
||||
\value{
|
||||
a numeric value stating the number of lines to be added or subtracted to align a logo with
|
||||
the caption
|
||||
}
|
||||
\description{
|
||||
Measure a ggplot2 object caption
|
||||
}
|
||||
\examples{
|
||||
p1 <- ggplot2::qplot(mpg, wt, data = mtcars)
|
||||
measure_caption(p1) # Should equal 1 since no caption is required
|
||||
}
|
||||
|
||||
+20
-20
@@ -1,20 +1,20 @@
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/utils.R
|
||||
\name{race_short_names}
|
||||
\alias{race_short_names}
|
||||
\title{Recode NCES race categories to shorter names}
|
||||
\usage{
|
||||
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"))
|
||||
}
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/utils.R
|
||||
\name{race_short_names}
|
||||
\alias{race_short_names}
|
||||
\title{Recode NCES race categories to shorter names}
|
||||
\usage{
|
||||
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"))
|
||||
}
|
||||
|
||||
+28
-28
@@ -1,28 +1,28 @@
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/utils.R
|
||||
\name{star_subs}
|
||||
\alias{star_subs}
|
||||
\title{Unsuppress data using sampling}
|
||||
\usage{
|
||||
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}
|
||||
|
||||
\item{max_value}{the numeric maximum value the replacement for the "*" can be}
|
||||
}
|
||||
\value{
|
||||
a numeric vector with no characters representing suppressed values
|
||||
}
|
||||
\description{
|
||||
Unsuppress data using sampling
|
||||
}
|
||||
\examples{
|
||||
suppr_data <- c("2", "8", "*", "*", "7", "9", "100")
|
||||
star_subs(suppr_data, zeros = 1, max_value = 10)
|
||||
star_subs(suppr_data, zeros = 1, max_value = 200)
|
||||
}
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/utils.R
|
||||
\name{star_subs}
|
||||
\alias{star_subs}
|
||||
\title{Unsuppress data using sampling}
|
||||
\usage{
|
||||
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}
|
||||
|
||||
\item{max_value}{the numeric maximum value the replacement for the "*" can be}
|
||||
}
|
||||
\value{
|
||||
a numeric vector with no characters representing suppressed values
|
||||
}
|
||||
\description{
|
||||
Unsuppress data using sampling
|
||||
}
|
||||
\examples{
|
||||
suppr_data <- c("2", "8", "*", "*", "7", "9", "100")
|
||||
star_subs(suppr_data, zeros = 1, max_value = 10)
|
||||
star_subs(suppr_data, zeros = 1, max_value = 200)
|
||||
}
|
||||
|
||||
+15
-15
@@ -1,15 +1,15 @@
|
||||
|
||||
|
||||
#' x <- LETTERS
|
||||
#' y <- c(letters, LETTERS)
|
||||
#' match_test(x, y)
|
||||
#'
|
||||
#'
|
||||
context("Test Basic Output for match_test")
|
||||
|
||||
test_that("pretty_per respects rounding", {
|
||||
x <- LETTERS
|
||||
y <- c(letters, LETTERS)
|
||||
testthat::expect_output(match_test(x, y))
|
||||
|
||||
})
|
||||
|
||||
|
||||
#' x <- LETTERS
|
||||
#' y <- c(letters, LETTERS)
|
||||
#' match_test(x, y)
|
||||
#'
|
||||
#'
|
||||
context("Test Basic Output for match_test")
|
||||
|
||||
test_that("pretty_per respects rounding", {
|
||||
x <- LETTERS
|
||||
y <- c(letters, LETTERS)
|
||||
testthat::expect_output(match_test(x, y))
|
||||
|
||||
})
|
||||
|
||||
@@ -0,0 +1,2 @@
|
||||
# test prop intervals
|
||||
|
||||
Reference in New Issue
Block a user