query.firm {FinNet}

Function to extract information from a firm object (legal person)

Description

Function to extract information from a firm object (legal person)

Usage

query.firm(firm, which, naming = TRUE)

Arguments

firm

Firm which to extract information from

which

Information to extract, minimum unambiguous substring. Possible values (one or more): - name Name of the firm - id ID of the firm, usually the ticker (if provided or otherwise known) - legal_form Legal form of the firm - sector Sector in which the firm operates - revenues Yearly revenues - capitalisation Capitalisation - management Members of the board - ownership Owner(s) - shares Share owned by (each of) the owner(s) - currency Currency in which revenues and capitalisation are denominated

naming

Whether to name the result after the querie information (defaults to TRUE)

Value

Depends on the information queried. One (or, if length(which)>=2, a list of two or more) of the following:

name

A string representing the name of the firm

id

A string representing the ID of the firm (usually its ticker)

legal_form

A string representing the firm's legal form

sector

A string indicating the sector in which the firm operates (possibly a NACE rev. 2 code)

revenues

A numeric (double) quantifying yearly revenues

capitalisation

A numeric (double) quantifying capitalisation

management

A vector of strings representing the members of the board

ownership

A vector of strings representing the owner(s)

shares

A numeric (double) vector indicating the shares controlled by (each of) the owner(s)

currency

A string indicating the currency in which revenues and capitalisation are denominated

Author(s)

Telarico, Fabio Ashtar

See Also

query.firms query.firms.dataframe

Examples

# Query Apple's capitalisation
data('firms_US')
list2env(firms_US, parent.frame())
query.firm(AAPL, which = 'capitalisation')

# Query British-American Tobacco's capitalisation using the common abbreviation 'cap'
data('firms_US')
list2env(firms_US, parent.frame())
query.firm(BTI, 'cap')

# Query General Motors's owners and their shares, but return an unnamed \code{\link{list}}
data('firms_US')
list2env(firms_US, parent.frame())
query.firm(GM, c('own', 'sha'), naming = FALSE)