Skip to content

Commit

Permalink
adding this stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
medewitt committed Apr 28, 2024
1 parent d34b10e commit bd7912b
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 27 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@
^_pkgdown\.yml$
^appveyor\.yml$
^\.github$
^CRAN-SUBMISSION$
40 changes: 14 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,11 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

<!-- badges here -->

[![CRAN
status](https://www.r-pkg.org/badges/version/tidyqwi)](https://cran.r-project.org/package=tidyqwi)
[![R build
status](https://github.com/medewitt/tidyqwi/workflows/R-CMD-check/badge.svg)](https://github.com/medewitt/tidyqwi/actions)
[![Travis build
status](https://travis-ci.org/medewitt/tidyqwi.svg?branch=master)](https://travis-ci.org/medewitt/tidyqwi)
[![AppVeyor build
status](https://ci.appveyor.com/api/projects/status/github/medewitt/tidyqwi?branch=master&svg=true)](https://ci.appveyor.com/project/medewitt/tidyqwi)[![Coverage
status](https://codecov.io/gh/medewitt/tidyqwi/branch/master/graph/badge.svg)](https://codecov.io/github/medewitt/tidyqwi?branch=master)
[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
[![](https://cranlogs.r-pkg.org/badges/tidyqwi)](https://cran.r-project.org/package=tidyqwi)[![DOI](http://joss.theoj.org/papers/10.21105/joss.01462/status.svg)](https://doi.org/10.21105/joss.01462)

<!-- end badges -->

Expand All @@ -27,8 +19,6 @@ level data, firm size, etc) and submit them to the US Census API. This
package then stays within the US Census guidelines for API submission
for this data and returns a combined tidy dataframe for future analysis.

This is a work in progress\!

## Installation

Install via CRAN with:
Expand All @@ -45,7 +35,7 @@ remotes::install_github("medewitt/tidyqwi")

## Use

After installation you can load and retrieve the desired data\!
After installation you can load and retrieve the desired data!

``` r
library(tidyqwi)
Expand All @@ -63,16 +53,15 @@ And look at your data:

``` r
head(nc_qwi)
#> # A tibble: 6 x 12
#> year quarter agegrp sex ownercode seasonadj industry state county Emp
#> <chr> <chr> <chr> <chr> <chr> <chr> <chr> <chr> <chr> <chr>
#> 1 2010 1 A00 0 A00 U 11 37 001 45
#> 2 2010 1 A00 0 A00 U 11 37 003 101
#> 3 2010 1 A00 0 A00 U 11 37 005 82
#> 4 2010 1 A00 0 A00 U 11 37 007 207
#> 5 2010 1 A00 0 A00 U 11 37 009 104
#> 6 2010 1 A00 0 A00 U 11 37 011 77
#> # … with 2 more variables: sEmp <chr>, year_time <date>
#> # A tibble: 6 × 12
#> year quarter agegrp sex ownercode seasonadj industry state county Emp sEmp year_time
#> <chr> <chr> <chr> <chr> <chr> <chr> <chr> <chr> <chr> <chr> <chr> <date>
#> 1 2010 1 A00 0 A00 U 11 37 001 45 1 2010-01-01
#> 2 2010 1 A00 0 A00 U 11 37 003 101 1 2010-01-01
#> 3 2010 1 A00 0 A00 U 11 37 005 82 1 2010-01-01
#> 4 2010 1 A00 0 A00 U 11 37 007 207 1 2010-01-01
#> 5 2010 1 A00 0 A00 U 11 37 009 104 1 2010-01-01
#> 6 2010 1 A00 0 A00 U 11 37 011 77 1 2010-01-01
```

And there are labels added if desired
Expand All @@ -84,10 +73,8 @@ labelled_nc <- add_qwi_labels(nc_qwi)
``` r
Hmisc::describe(labelled_nc$Emp)
#> labelled_nc$Emp : Beginning-of-Quarter Employment: Counts
#> n missing distinct Info Mean Gmd .05 .10
#> 7345 411 2851 1 2018 3129 24 40
#> .25 .50 .75 .90 .95
#> 132 448 1550 4355 8099
#> n missing distinct Info Mean Gmd .05 .10 .25 .50 .75 .90 .95
#> 7345 411 2851 1 2018 3129 24 40 132 448 1550 4355 8099
#>
#> lowest : 0 1 3 4 5, highest: 65243 81884 82723 84038 84674
```
Expand Down Expand Up @@ -118,11 +105,12 @@ labelled_nc %>%
x = "Month"
)+
theme_minimal()
#> Warning in vp$just: partial match of 'just' to 'justification'
```

<img src="man/figures/README-unnamed-chunk-8-1.png" width="100%" />

Please note that the ‘tidyqwi’ project is released with a [Contributor
Code of
Conduct](https://github.com/medewitt/tidyqwi/blob/master/CODE_OF_CONDUCT.md).
Conduct](https://github.com/medewitt/tidyqwi/blob/main/CODE_OF_CONDUCT.md).
By contributing to this project, you agree to abide by its terms.
2 changes: 1 addition & 1 deletion inst/CITATION
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ bibentry(
volume = "4",
number = "38",
pages = "1462",
url = "http://joss.theoj.org/papers/10.21105/joss.01462",
url = "https://joss.theoj.org/papers/10.21105/joss.01462",
textVersion = paste("DeWitt et al., (2019).",
"tidyqwi: A Tidy Approach to Accessing The US Census Bureau's Quarterly Workforce Indicators.",
"Journal of Open Source Software, 4(38), 1462,",
Expand Down

0 comments on commit bd7912b

Please sign in to comment.