derivativeTransactionsScrape: derivativeTransactionsScrape
In insiderTrades: Tools to Download Insider Transactions and Holdings

Description Usage Arguments Value Examples

View source: R/derivativeTransactionsScrape.R

The function takes the dataframe returned by secUrlDownload and scrapes and compiles a dataframe of all the derivative transactions that meet the keyword crtiera. If no criteria is set, all transactions from the dataframe returned by secUrlDownload 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 transaction has only one of the footnoteKeywords and none of the issuerKeywords, the transaction will still be scraped.

derivativeTransactionsScrape(
  index,
  form,
  name,
  email,
  transactionType = NA,
  footnoteKeywords = NA,
  issuerKeywords = NA,
  issuerTradingSymbol = NA,
  rptOwnerKeywords = NA
)

`index`	A local object that was returned by utilizing the `secUrlDownload`. It contains the URLs necessary to grab each text version of the filed Form 4 or 5.
`form`	Define if the form is a Form 4 or Form 5. Must match the type used in `secUrlDownload`.
`name`	Specify your name. This is required by the SEC.
`email`	Specify your email. This is required by the SEC.
`transactionType`	The character vector containing any specified transaction codes. Values must be captilized to match against SEC values. Detailed information about the transaction type can be found here: https://www.sec.gov/files/forms-3-4-5.pdf. Default value is NA.
`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 transaction. The transaction observations can be grouped by form through the URL variable within the dataframe.

1
2
3

dat <- derivativeTransactionsScrape(index = tempIndex, form = 4,
name = "Your Name", email = "yourEmail@yourEmail.com",
issuerKeywords = c("AMAZON", "MICROSOFT"))