get8KItems: Retrieves Form 8-K event information

Description Usage Arguments Details Value Examples

View source: R/get8KItems.R

Description

get8KItems retrieves Form 8-K event information of firms based on CIK numbers and filing year.

Usage

1
get8KItems(cik.no, filing.year, useragent)

Arguments

cik.no

vector of CIK(s) in integer format. Suppress leading zeroes from CIKs.

filing.year

vector of four digit numeric year

useragent

Should be in the form of "Your Name Contact@domain.com"

Details

get8KItems function takes firm CIK(s) and filing year(s) as input parameters from a user and provides information on the Form 8-K triggering events along with the firm filing information. The function searches and imports existing downloaded 8-K filings in the current directory; otherwise it downloads them using getFilings function. It then reads the 8-K filings and parses them to extract events information. According to SEC EDGAR's guidelines a user also needs to declare user agent.

Value

Function returns dataframe with Form 8-K events information along with CIK number, company name, date of filing, and accession number.

Examples

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

output <- get8KItems(cik.no = 38079, filing.year = 2005, useragent)
## Returns 8-K event information for CIK '38079' filed in year 2005.

output <- get8KItems(cik.no = c(1000180,38079), 
                     filing.year = c(2005, 2006), useragent) 

## End(Not run)

Gunratan/edgar documentation built on Dec. 17, 2021, 10:25 p.m.