formFilters: formFilters

In insiderTrades: Tools to Download Insider Transactions and Holdings

Description

formFilters

Usage

formFilterNonderivativeTransactions(
  filing,
  footnoteKeywords,
  issuerKeywords,
  issuerTradingSymbol,
  rptOwnerKeywords,
  transactionType
)

formFilterDerivativeTransactions(
  filing,
  footnoteKeywords,
  issuerKeywords,
  issuerTradingSymbol,
  rptOwnerKeywords,
  transactionType
)

formFilterNonderivativeHoldings(
  filing,
  footnoteKeywords,
  issuerKeywords,
  issuerTradingSymbol,
  rptOwnerKeywords
)

formFilterDerivativeHoldings(
  filing,
  footnoteKeywords,
  issuerKeywords,
  issuerTradingSymbol,
  rptOwnerKeywords
)

Arguments

filing	The object containing the Form 4 text
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. Default is NA.
issuerTradingSymbol	The character vector containing any specified stock tickers. Default is NA.
rptOwnerKeywords	The character vector contianing any specified key words to be searched within the rptOwner block. Default is NA.
transactionType	The character vector containing any specified transaction codes. Default is NA.

Value

An integer value that if greater than 0, reflects that at the one of the criteria parameters listed above has been met. The form will then be parsed further. Otherwise, if the integer value is 0, the function pulls in the next Form 4 to evaluate.

Note

formFilterNonderivativeTransactions parses the form and returns an integer value greater than 0 if one of the key word criteras is met. This function is specifically for the nonderivativeTransactionsScrape and nonderivativeTransactionsPullAndScrape functions.

formFilterDerivativeTransactions parses the form and returns an integer value greater than 0 if one of the key word criteras is met. This function is specifically for the derivativeTransactionsScrape and derivativeTransactionsPullAndScrape functions. The function shares the same paramters as formFilterNonderivativeTransactions (filing, footnoteKeywords, issuerKeywords, issuerTradingSymbol, rptOwnerKeywords, transactionType). The only difference is within the parsing commands which use the key word derivative rather than nonderivative.

formFilterNonderivativeHoldings parses the form and returns an integer value greater than 0 if one of the key word criteras is met. This function is specifically for the nonderivativeHoldingsScrape and nonderivativeHoldingsPullAndScrape functions. The function shares the same paramters as formFilterNonderivativeTransactions (filing, footnoteKeywords, issuerKeywords, issuerTradingSymbol, rptOwnerKeywords) except for transactionType since that isn't a criteria for a nonderivative holdings. Additionally, parsing criteria is different due to targeting holding information rather than transaction information.

formFilterDerivativeHoldings parses the form and returns an integer value greater than 0 if one of the key word criteras is met. This function is specifically for the derivativeHoldingsScrape and derivativeHoldingsPullAndScrape functions. The function shares the same paramters as formFilterNonderivativeHoldings (filing, footnoteKeywords, issuerKeywords, issuerTradingSymbol, rptOwnerKeywords) except for transactionType since that isn't a criteria for a derivative holdings. The only difference is within the parsing commands which use the key word derivative rather than nonderivative.

insiderTrades documentation built on Oct. 5, 2021, 1:06 a.m.