-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathREADME.qmd
76 lines (54 loc) · 3.96 KB
/
README.qmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
---
title: "federalregister: An R Client for the U.S. Federal Register API v1"
format: gfm
execute:
echo: true
---
[](http://cran.r-project.org/package=federalregister)
[](https://travis-ci.org/rOpenGov/federalregister)
This package provides access to the [API](https://www.federalregister.gov/developers/api/v1) for the [United States Federal Register](https://www.federalregister.gov/). The API provides access to [all Federal Register contents since 1994](https://www.federalregister.gov/learn/developers), including Executive Orders by Presidents Clinton, Bush, and Obama and all ["Public Inspection" Documents](https://www.federalregister.gov/learn/public-inspection-desk-2) made available prior to publication in the Register. The API returns basic details about each entry in the Register and provides URLs for HTML, PDF, and plain text versions of the contents thereof, and the data are fully searchable. The `federalregister` package provides access to all version 1 API endpoints.
## Installing the package ##
The package can be installed from GitHub:
```
if (!library('devtools')) {
install.packages('devtools')
library('devtools')
}
install_github('rOpenGov/federalregister')
library('federalregister')
```
### Examples
Below are some examples of possible uses of the package.
### Executive Orders, by President
One cool feature of the Federal Register API is the ability to retrieve Executive Orders. Constructing the necessary API request, for example, to retrieve all Executive Orders for 2013 from President Obama is a bit complicated:
https://www.federalregister.gov/api/v1/articles.json?conditions%5Bcorrection%5D=0&conditions%5Bpresident%5D=barack-obama&conditions%5Bpresidential_document_type_id%5D=2&conditions%5Bpublication_date%5D%5Byear%5D=2013&conditions%5Btype%5D=PRESDOCU&fields%5B%5D=executive_order_number&fields%5B%5D=title&fields%5B%5D=publication_date&fields%5B%5D=signing_date&fields%5B%5D=citation&fields%5B%5D=document_number&fields%5B%5D=executive_order_notes&fields%5B%5D=html_url&fields%5B%5D=full_text_xml_url&fields%5B%5D=body_html_url&fields%5B%5D=json_url&order=executive_order_number&per_page=1000
Doing it using `federalregister` is quite a bit easier:
```{r}
library('federalregister')
clinton <- fr_search(presidential_document_type='executive_order',
president='william-j-clinton', per_page=1000)
bush <- fr_search(presidential_document_type='executive_order',
president='george-w-bush', per_page=1000)
obama <- fr_search(presidential_document_type='executive_order',
president='barack-obama', per_page=1000)
# number of Executive Orders
c(clint=clinton$count, bush=bush$count, obama=obama$count)
```
### Prevalence of Agency Mentions ###
Each Federal Registry entry includes data on agency mentions (i.e., what agencies the entry applies to). We can use this information to analyze which agencies are getting attention, even over time.
```{r}
library('federalregister')
a <- c('barry-m-goldwater-scholarship-and-excellence-in-education-foundation',
'assassination-records-review-board',
'arctic-research-commission')
out <- lapply(a, function(x) fr_search(agencies=x, fields='', per_page=1000)$results)
setNames(sapply(out, length), a)
```
### Text-mining the Federal Register ###
The API returns metadata about entries in the Federal Register, including links to HTML, PDF, and plain text versions of entries in the Federal Register. Using `federalregister` to retrieve the plain text URLs, it is then possible to reconstruct the contents of the Register for use in, e.g., some kind of text mining analysis.
```{r}
arecord <- fr_get('E9-1719')
full <- httr::content(httr::GET(arecord[[1]]$raw_text_url), "text", encoding = "UTF-8")
cat(substring(full, 1, 1000))
```