-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
3 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,11 +20,13 @@ The package is maintained on | |
# Implementation of the edgar package | ||
|
||
## SEC guidelines on downloading EDGAR files | ||
Please download only what you need and moderate downlaod requests to minimize server load. A user is required to declare user agent in request headers. The following link explains these requirements in details. | ||
Please download only what you need and moderate downlaod requests to minimize EDGAR server load. A user is required to declare user agent in request headers. The following link explains these requirements in details. | ||
https://www.sec.gov/os/accessing-edgar-data | ||
|
||
Accordingly, `edgar` package requires user to pass user agent in every function. It should be in the form of | ||
``` r | ||
useragent = "Your Name [email protected]" | ||
``` | ||
|
||
## Download daily filing information | ||
The `getDailyMaster` function takes date as an input parameter from a user, and downloads master index for the date from the U.S. SEC EDGAR server https://www.sec.gov/Archives/edgar/daily-index/. It strips headers and converts this daily filing information into dataframe format. Function creates new directory 'Daily Indexes' into working directory to save these downloaded daily master index files in Rda format. | ||
|