Skip to content

Commit 881c66f

Browse files
authored
Merge pull request #32 from QuantGov/dev
updated readme with get_datafinder function
2 parents b79d431 + 7f32569 commit 881c66f

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,14 @@ Use the __get_jurisdiction__ function to return a data frame with all the jurisd
5959
rc.get_jurisdictions()
6060
```
6161

62+
### DataFinder
63+
64+
Use the __get_datafinder__ function to return a data frame for a specific jurisdiction. It returns the following attributes in the data - `['jurisdiction', 'documentType', 'year', 'series', 'document_endpoints', 'summary_endpoints', 'label_endpoints']`
65+
66+
```
67+
get_datafinder(jurisdiction = 38)
68+
```
69+
6270
### Agencies
6371

6472
The __get_agencies__ function returns a data frame of agencies with data in RegData. Either the `jurisdictionID` or `keyword` arguments must be supplied. If `jurisdictionID` is passed, the data frame will include information for all agencies in that jurisdiction. If `keyword` is supplied, the data frame will include information for all agencies whose name contains the keyword.

0 commit comments

Comments
 (0)