Skip to content

Commit

Permalink
cran
Browse files Browse the repository at this point in the history
  • Loading branch information
hrecht committed Apr 14, 2019
1 parent a6fc035 commit 4620780
Show file tree
Hide file tree
Showing 11 changed files with 54 additions and 58 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ _pkgdown.yaml
cran-comments.md
CODE_OF_CONDUCT.md
pkgdown/
^pkgdown$
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ BugReports: https://github.com/hrecht/censusapi/issues
Depends: R (>= 3.0.0)
License: GPL-3
LazyData: true
RoxygenNote: 6.1.0
RoxygenNote: 6.1.1
Imports:
httr,
jsonlite
Expand Down
1 change: 0 additions & 1 deletion R/datasets.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
#' Some small geographies in some Census APIs can only be used under a state hierarchy.
#' This is a list of fips codes that may be looped over to retrieve data for all states.
#' @format A list of fips codes for 50 states and the District of Columbia
#' @source \url{https://www.census.gov/geo/reference/ansi_statetables.html}
#' @examples
#' fips
"fips"
9 changes: 3 additions & 6 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
## Test environments
* local OS X install, R 3.3.3
* local OS X install, R 3.5.0
* Ubuntu 14.04.5 LTS (on travis-ci), R version 3.4.4 (2017-01-27)
* Ubuntu 14.04.5 LTS (on travis-ci), R version 3.5.0 (2017-01-27)
* Ubuntu 14.04.5 LTS (on travis-ci), R version 2018-08-19 r75169
* win-builder (devel, release and oldrelease)
* local OS X install, R 3.5.3
* Ubuntu 14.04.5 LTS (on travis-ci), R 3.4.4 (oldrel), R 3.5.3 (release), R 2019-04-13 r76388 (devel)
* win-builder (oldrel, release and devel)

## R CMD check results
There were no ERRORs, WARNINGs, or NOTEs.
Expand Down
70 changes: 35 additions & 35 deletions docs/articles/example-masterlist.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 10 additions & 3 deletions docs/articles/getting-started.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/news/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 0 additions & 6 deletions docs/reference/fips.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions man/fips.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion vignettes/getting-started.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -278,11 +278,13 @@ The APIs contain hundreds of API endpoints and dozens of datasets, each of which

### Variables
Use `listCensusMetadata(type = "variables")` on your API to see the table of available variables.

* Occasionally the variable names will change with data updates or API updates. The names may be different from year to year.
* The Census APIs are case-sensitive, which means that if the variable name you want is uppercase you'll need to write it uppercase in your request. Most of the APIs use uppercase variable names, but some use lowercase and some even use sentence case.

### Geographies
Use `listCensusMetadata(type = "geographies")` on your dataset to check which geographies you can use.

* Each API has its own list of valid geographies and they occasionally change as the Census Bureau makes updates. If a previously available geography isn't available anymore, email [email protected] detailing the issue.
* If you're specifying a region by FIPS code, for example `state:01`, make sure to use the full code, padded with 0s if necessary. The APIs did not always enforce this (previously, `state:1` usually worked), but now they do. See the Census [reference files](https://www.census.gov/geographies/reference-files/2017/demo/popest/2017-fips.html) for valid FIPS codes.

Expand All @@ -296,7 +298,6 @@ Occasionally you might get the general error message `"There was an error while

## Additional resources
* [Census Data API User Guide](https://www.census.gov/data/developers/guidance/api-user-guide.Overview.html)
* [FIPS codes](https://www.census.gov/geo/reference/ansi_statetables.html)

## Disclaimer
This product uses the Census Bureau Data API but is not endorsed or certified by the Census Bureau.

0 comments on commit 4620780

Please sign in to comment.