Skip to content

Commit b79d431

Browse files
authored
Update README.md
1 parent bb6e399 commit b79d431

1 file changed

Lines changed: 13 additions & 23 deletions

File tree

README.md

Lines changed: 13 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ RegCensus API defines a number of dates depending on the series. For example, th
3535

3636
There are five helper functions to retrieve information about these key components of regdata. These functions provider the following information: document types, jurisdictions, series, agencies, and dates with data. The list functions begin with __list__.
3737

38-
Each document type comprises one or more *series*. The __list_series__ function returns the list of all series when no series id is provided.
38+
Each document type comprises one or more *series*. The __list_series__ function returns the list of all series.
3939

4040
```
41-
rc.list_series(jurisdictionID = 38)
41+
rc.list_series()
4242
```
4343

4444
Listing the jurisdictions is another great place to start. If you are looking for data for a specifc jurisdiction(s), this function
@@ -66,7 +66,7 @@ The __get_agencies__ function returns a data frame of agencies with data in RegD
6666
The following code snippet will return data for all agencies in the Federal United States:
6767

6868
```
69-
rc.get_agencies(jurisdiction = 38)
69+
rc.get_agencies(jurisdictionID = 38)
7070
```
7171

7272
Likewise, this code snippet will return data for all agencies (in any jurisdiction) containing the word "education" (not case sensitive):
@@ -84,38 +84,28 @@ The __get_industries__ function returns a data frame of industries with data in
8484
The following line will get you industry information for all 4-digit NAICS industries:
8585

8686
```
87-
rc.get_industries(codeLevel = 4)
87+
rc.get_industries(labellevel = 4)
8888
```
8989

90-
This line will get you information for the BEA industries:
90+
This line will get you information for the BEA industries (this function is temporarily disabled as of 1.0.0):
9191

9292
```
93-
rc.get_industries(standard = 'BEA')
93+
rc.get_industries(labelsource = 'BEA')
9494
```
9595

96-
Like the __get_agencies__ function, the `keyword` argument may also be used. The following code snippet will return information for all 6-digit NAICS industries with the word "fishing" in the name:
96+
Like the __get_agencies__ function, the `keyword` argument may also be used. The following code snippet will return information for all 6-digit NAICS industries with the word "fishing" in the name (this function is temporarily disabled as of 1.0.0):
9797

9898
```
9999
rc.get_industries(keyword = 'fishing', codeLevel = 6)
100100
```
101101

102-
### Documents
103-
104-
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 1, which is "all regulations").
105-
106-
The following line will get metadata for documents associated with U.S. Federal healthcare regulations.
107-
108-
```
109-
rc.get_documents(jurisdictionID = 38, documentType = 3)
110-
```
111-
112102
## Values
113103

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

116106
* jurisdiction (required) - value or list of jurisdiction IDs
117107
* series (required) - value or list of series IDs
118-
* date (required) - value or list of years
108+
* year (required) - value or list of years
119109
* agency (optional) - value or list of agencies
120110
* industry (optional) - value of list of agencies
121111
* dateIsRange (optional) - specify if the list of years provided for the parameter years is a range. Default is True.
@@ -130,15 +120,15 @@ The __get_values__ function is the primary function for obtaining RegData from t
130120
In the example below, we are interested in the total number of restrictions and total number of words for the US (get_jurisdictions(38)) for the dates 2010 to 2019.
131121

132122
```
133-
rc.get_values(series = [1,2], jurisdiction = 38, date = [2010, 2019])
123+
rc.get_values(series = [1,2], jurisdiction = 38, year = [2010, 2019])
134124
```
135125

136126
### Get all Values for a Country
137127

138-
The `country` argument can be used to get all values for one or multiple series for a specific national jurisdiction. The following line will get you a summary of the national and state-level restriction counts for the United States from 2016 to 2019:
128+
The `country` argument can be used to get all values for one or multiple series for a specific national jurisdiction. The following line will get you a summary of the national and state-level restriction counts for the United States from 2016 to 2019 (this function is temporarily disabled as of 1.0.0):
139129

140130
```
141-
rc.get_values(series = 1, jurisdiction = 38, date = [2016, 2019], country=True)
131+
rc.get_values(series = 1, jurisdiction = 38, year = [2016, 2019], country=True)
142132
```
143133

144134
### Values by Subgroup
@@ -153,8 +143,8 @@ To obtain the restrictions for a specific agency (or agencies), the series id su
153143
# Identify all agencies
154144
rc.list_agencies(jurisdictionID)
155145
156-
# Call the get_values() for this agency and series 91
157-
rc.get_values(series = 91, jurisdiction = 38, date = [1990, 2018], agency = [81, 84])
146+
# Call the get_values() for two agencies and series 13
147+
rc.get_values(series = 13, jurisdiction = 38, year = [2000, 2018], agency = [15918, 15921])
158148
```
159149

160150
#### Values by Agency and Industry

0 commit comments

Comments
 (0)