getFilingInfo: Retrieves filing information of a firm

Description Usage Arguments Details Value Examples

View source: R/getFilingInfo.R

Description

getFilingInfo retrieves filing information of a firm based on its name or cik.

Usage

1
getFilingInfo(firm.identifier, filing.year, quarter, form.type)

Arguments

firm.identifier

CIK of a firm in integer format or full/partial name of a firm in character format. Suppress leading zeroes from CIKs.

filing.year

vector of integer containing filing years.

quarter

vector of one digit integer quarter number. By default, it is considered as all the quarters, quarter =c(1, 2, 3, 4).

form.type

vector of form types in character format. By default, it is kept as all the available form types.

Details

getFilingInfo function takes firm identifier (name or cik), filing year(s), quarter(s), and form type as input parameters from a user and provides filing information for the firm. The function automatically downloads master index for the input year(s) and the quarter(s) using getMasterIndex function if it is not already been downloaded in the current working directory. By default, information of all the form types filed in all the quarters of the input year by the firm will be provided by this function.

Value

Function returns dataframe with filing information.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## Not run: 

info <- getFilingInfo('United Technologies', c(2005, 2006), 
                       quarter = c(1,2), form.type = c('8-K','10-K')) 
## Returns filing information on '8-K' and '10-K' filed by the firm 
in quarter 1 and 2 of year 2005 and 2006.

info <- getFilingInfo(1067701, 2006) 
## Returns all the filings information filed by the firm in all 
the quarters of year 2006.

## End(Not run)

edgar documentation built on July 2, 2020, 2:36 a.m.

Related to getFilingInfo in edgar...