Description Usage Arguments Value Examples
View source: R/derivativeHoldingsPullAndScrape.R
The function takes the specifieid quarter (1-4), year (2004- 2021), and form type (4 or 5) and returns a dataframe of all the derivative holdings that meet the keyword crtiera from the specified financial quarter. If no criteria is set, all holdings from the financial quarter are scraped. Note that the logic for the keywords is "OR." Thus if a user sets multiple footnoteKeywords and a keyword for issuerKeywords, if a holding has only one of the footnoteKeywords and none of the issuerKeywords, the holding will still be scraped.
1 2 3 4 5 6 7 8 9 10 11 |
quarter |
Specify the financial reporting quarter. Options are 1, 2, 3, and 4. |
year |
Specify the calendar year. Options range from 2004 to present. |
form |
Specify the form type. Options are 4 or 5. |
name |
Specify your name. This is required by the SEC. |
email |
Specify your email. This is required by the SEC. |
footnoteKeywords |
The character vector containing any specified key words to be searched in the form's footnotes. Default is NA. |
issuerKeywords |
The character vector containing any specified key words to be searched within the issuer block. Criteria can include the firms CIK or name. Values must be captilized to match against SEC values. Default value is NA. |
issuerTradingSymbol |
The character vector containing any specified stock tickers. Values must be captilized to match against SEC values. Default value is NA. |
rptOwnerKeywords |
The character vector contianing any specified key words to be searched within the rptOwner block. Values must be captilized to match against SEC values. Additionally, the format is LAST NAME, FIRST NAME. The criteria can include the individuals CIK, address, or name. Default value is NA. |
A dataframe containing containing the scraped information where each row represents a derivative holding The holding observations can be grouped by form through the URL variable within the dataframe.
1 2 3 | dat <- derivativeHoldingsPullAndScrape(quarter = 3, year = 2012, form = 4,
name = "Your Name", email = "yourEmail@yourEmail.com",
footnoteKeywords = c("gift", "charity"))
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.