https://github.com/christopherkenny/baf

https://github.com/christopherkenny/baf

Last synced: 28 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/christopherkenny/baf
• Owner: christopherkenny
• License: other
• Created: 2023-06-05T01:51:48.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-10T23:55:49.000Z (3 months ago)
• Last Synced: 2024-09-12T23:45:26.771Z (about 2 months ago)
• Language: R
• Homepage: http://christophertkenny.com/baf/
• Size: 1.19 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = '#>',

  fig.path = 'man/figures/README-',

  out.width = '100%'

)

```

# baf 

[![R-CMD-check](https://github.com/christopherkenny/baf/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/christopherkenny/baf/actions/workflows/R-CMD-check.yaml)

[![baf status

badge](https://christopherkenny.r-universe.dev/badges/baf)](https://christopherkenny.r-universe.dev/baf)

The goal of `baf` is to provide lightweight block assignment (and equivalence) files from the US Census Bureau.

## Installation

You can install the development version of baf like so:

``` r

pak::pak('christopherkenny/baf')

```

## Example

The workhorse function for `baf` is the `baf()` function.

```{r}

library(baf)

baf(state = 'NM', year = 2024, geographies = 'cd')

```

## Cache

By default, `baf` loads files to a temporary directory.

To retain files across sessions, set the `cache_to` argument to a directory of your choosing.

You can also set `options(baf.use_cache = TRUE)` to create a user-level cache that can persist across projects.