Skip to content

Commit 7dc80ad

Browse files
committed
get_documents documentation
1 parent e76768a commit 7dc80ad

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,12 @@ rc.list_jurisdictions(jurisdictionID = 38)
4444
Just like the above function call, listing the jurisdictions is another great place to start. If you are looking for data for a specifc jurisdiction(s), this function
4545
will return the jurisdiction_id for all jurisdiction, which is key for retrieving data on any individual jurisdiction.
4646

47-
The __get_series_period__ function returns a list of all seriesa and the years with data available.
47+
The __get_periods__ function returns a list of all seriesa and the years with data available.
4848

4949
The output from this function can serve as a reference for the valid values that can be passed to parameters in the __get_values__ function. The number of records returned is the unique combination of series and jurisdictions that are available in RegData. The function takes the optional argument jurisdiction id.
5050

5151
```
52-
rc.get_series_period(jurisdictionID = 38)
52+
rc.get_periods(jurisdictionID = 38)
5353
```
5454

5555
## Metadata
@@ -81,6 +81,16 @@ The __get_industries__ function returns a data frame of industries with data in
8181
rc.get_industries(38)
8282
```
8383

84+
### Documents
85+
86+
The __get_documents__ function returns a data frame with metadata for document-level data. The fucntion takes two parameters, jurisdictionID (required) and documentType (default value of 3, which is "all regulations").
87+
88+
The following line will get metadata for documents associated with U.S. Federal healthcare regulations.
89+
90+
```
91+
rc.get_documents(jurisdictionID = 38, documentType = 1)
92+
```
93+
8494
## Values
8595

8696
The __get_values__ function is the primary function for obtaining RegData from the RegCensus API. The function takes the following parameters:

0 commit comments

Comments
 (0)