getStatement: Create finantial report

In kossal/fundfi: Fundamental XBRL financial analysis

Description

Create specified finantial report from XBRL list.

Usage

getStatement(
  xbrl.vars = NULL,
  statement = "balance_sheet",
  custom.description = NULL
)

Arguments

xbrl.vars	XBRL list of data.frames
statement	Type of statement. Can be balance_sheet, income_statement and cash_flow
custom.description	Character to fetch roleId using description from roles data.frame

Details

Creates a data.frame containing a finantial report using a XBRL list returned by XBRL library. It uses the calculation data.frame to unite elements with facts, contexts and labels. Income statements and cash flows sometimes have diferent start dates for a element with the same end date, in this case it will use the last start date. Each company uses diferent descriptions for the same roles (balance sheet, income statement and cash flow). This library tries it best using regex to get every posible description but of course there will be exceptions or the user might want to use a diferent concept. For this case, you can use the parameter custom.description to use your own description.

Value

data.frame as a financial report

Examples

getStatement(getXBRL(c("PG", type="10-Q"))$PG, statement = "income_statement")

kossal/fundfi documentation built on April 6, 2020, 8:41 a.m.