| Title: | An Easier Access to Financial Accounts of the United States(Z.1) |
| Version: | 0.1.0 |
| Description: | Flow of funds are financial accounts that are provided by Federal Reserve quarterly. The package contains all datasets https://www.federalreserve.gov/datadownload/Choose.aspx?rel=z1, tables https://www.federalreserve.gov/apps/fof/FOFTables.aspx and descriptions https://www.federalreserve.gov/apps/fof/Guide/z1_tables_description.pdf with functions to understand series https://www.federalreserve.gov/apps/fof/SeriesStructure.aspx and explore them. |
| URL: | https://github.com/shaf1430/fedz1 |
| BugReports: | https://github.com/shaf1430/fedz1/issues |
| License: | MIT + file LICENSE |
| Encoding: | UTF-8 |
| Depends: | R (≥ 2.10) |
| LazyData: | true |
| RoxygenNote: | 6.1.1 |
| Suggests: | testthat |
| NeedsCompilation: | no |
| Packaged: | 2023-01-27 22:02:34 UTC; 344920 |
| Author: | Hamid Shafiezadeh [aut, cre] |
| Maintainer: | Hamid Shafiezadeh <shafiezadehhamid@gmail.com> |
| Repository: | CRAN |
| Date/Publication: | 2023-01-30 16:20:08 UTC |
Title of tables
Description
all_tables_title() returns title of all tables. It is helpful to get familiar with available tables. Each table contains
a number of data set.
Usage
all_tables_title()
Value
A tibble of title of all tables
See Also
https://www.federalreserve.gov/apps/fof/FOFTables.aspx
Examples
all_tables_title()
Data
Description
The function returns data series or tables. Due to CRAN package size requirements, the data is stored on github.
Usage
get_series(choice = c("series", "tables"))
Arguments
choice |
can be "series" or "tables |
Details
get_series() load entire series or tables. For example: get_series(choice="series")
series_data contains all series available in flow of funds and tables_data contains all tables and series
Value
series or tables
series_data
date - Time-period
value - Observed-Value
SERIES_NAME - name of a series. There are more than twenty thousands series exist
CURRENCY - USD or NA. NA means series is percent or index
SERIES_PREFIX - Each prefix letters indicate the series type. see fedz1:::meaning_of_prefix()
UNIT - Currency, percent or index
UNIT_MULT - 1,1,000 or 1,000,000
short description _ description of the series
FREQ - A:annually data; Q:quarterly data
tables_data
tname - name of a table
SERIES_NAME - name of a series. There are more than twenty thousands series exist
Description - Long Description of series
date - Time-period
value - Observed-Value
UNIT - Currency, percent or index
See Also
https://www.federalreserve.gov/datadownload/Choose.aspx?rel=z1
https://www.federalreserve.gov/apps/fof/FOFTables.aspx
Definition of series prefix
Description
meaning_of_prefix() returns definition of series. Each series start with two letters. Each prefix letters indicate the series type.
Usage
meaning_of_prefix(prefix)
Arguments
prefix |
is SERIES_PREFIX. Value could be FA, FC, FG, FI, FL, FR, FS, FU, FV, LA, LM, PC. |
Value
character for definition of series
See Also
https://www.federalreserve.gov/apps/fof/SeriesStructure.aspx
Examples
meaning_of_prefix("FL")
Meaning of prefix
Description
Each prefix letters indicate the series type
Usage
mprefix
Format
mprefix
A data frame with 12 rows and 2 columns:
- SERIES_PREFIX
prefix of series
- meaning
meaning of a prefix
Source
https://www.federalreserve.gov/apps/fof/SeriesStructure.aspx
Title of series with a short description
Description
Data is obtained from a web scraping from flow of funds website
Usage
prds
Format
prds
A data frame with 11,291 rows and 2 columns:
- title1
series name
- short description
description of the series
Source
https://www.federalreserve.gov/datadownload/Choose.aspx?rel=z1
search series
Description
search_series() return all series with the search. For example: search_series("Real estate investment trusts")
Usage
search_series(series)
Arguments
series |
is SERIES name |
Value
A tibble of series
search tables
Description
search_tables() return series associated with a table
Usage
search_tables(tables)
Arguments
tables |
is table name |
Value
A tibble of series in a table
Examples
search_tables("Nonfinancial Corporate Business")
Description of a table
Description
table_descr() return the definition of a table. Each table contains a number of data set.
Usage
table_descr(table_title)
Arguments
table_title |
is name of a single table or vector of multiple tables. You can obtain title of tables by |
Value
character for definition of a table(s)
See Also
https://www.federalreserve.gov/apps/fof/Guide/z1_tables_description.pdf
Examples
table_descr('Credit Unions')
table_descr(c('Net Capital Transfers',"Closed-End Funds"))
Title of tables
Description
Data is obtained from a web scraping from Financial Accounts Guide
Usage
table_detail
Format
table_detail
A data frame with 198 rows and 3 columns:
- summary
title as shows on the source website
- name
title of the table
- code
code of each table as shows on the source website