Add documentation for fiscal variables

Author: fjuniorr

R/fiscal_data.R

@@ -2,6 +2,41 @@
 #'
 #' Fiscal variables on Brazilian subnational governments
 #'
-#' @format data.frame
-#'
+#' @format A data frame with 243 observations and 32 variables
+#' \describe{
+#' \item{id}{Unique observation identifier}
+#' \item{state}{Subnational government alphabetic identifier code}
+#' \item{year}{Year}
+#' \item{region}{Region of subnational government}
+#' \item{state_calamity}{Dummy variable equal to one if the state declared financial calamity in any year}
+#' \item{calamity}{Dummy variable equal to one if the state declated financial calamity in a given year}
+#' \item{dcb}{Gross debt}
+#' \item{rcl}{Net current revenue}
+#' \item{juros}{Interest payments}
+#' \item{amortizacao}{Principal payments}
+#' \item{primario}{Primary balance}
+#' \item{dbp}{Compensation of employees}
+#' \item{rec_cor}{Current revenue}
+#' \item{desp_cor}{Current expenses}
+#' \item{investimentos}{Gross investment in nonfinancial assets}
+#' \item{desp_total}{Total expenditure}
+#' \item{rec_previdenciarias}{Social contributions}
+#' \item{inativos}{Social benefits}
+#' \item{rec_tributaria}{Tax revenues}
+#' \item{obrig_fin}{Current liabilities}
+#' \item{disp_caixa_bruta}{Cash and cash equivalents}
+#' \item{stn_end}{Gross Debt / Net current revenue}
+#' \item{stn_sdrcl}{Debt service / Net current revenue}
+#' \item{stn_rpsd}{Primary balance / Debt service}
+#' \item{stn_dprcl}{Compensation of employees / Net current revenue}
+#' \item{stn_cgpp}{Current fiscal balance / Current revenue}
+#' \item{stn_pidt}{Gross investment in nonfinancial assets / Total expenditure}
+#' \item{stn_pcrdp}{Social contributions / Social benefits}
+#' \item{stn_rtdc}{Tax revenues / (Current expenses + Principal payments)}
+#' \item{capag_idc}{Gross Debt / Net current revenue}
+#' \item{capag_pc}{Current expenses / Current revenue}
+#' \item{capag_il}{Current liabilities / Cash and cash equivalents}
+#' }
+#' @examples
+#' fiscal_data
 "fiscal_data"

README.Rmd

@@ -8,6 +8,8 @@ bibliography: references.bib
 knitr::opts_chunk$set(echo = TRUE)
 ```
 
+# Brazilian subnational governments fiscal data
+
 This package aims to make available in machine readable format regional discriminated data on the fiscal variables that are needed to compute the fiscal indicators used by the Brazilian National Treasury Secretariat (NTS) for payment capacity evaluation.
 
 # Installation
@@ -21,7 +23,7 @@ if (!require("devtools")) {
 devtools::install_github("fjuniorr/junior2017")
 ```
 
-Alternatively, a `csv` file with the dataset can be downloaded [here](https://github.com/fjuniorr/junior2017/raw/master/data-raw/fiscal_data.csv).
+Alternatively, a `csv` file with the dataset can be downloaded <a href="https://github.com/fjuniorr/junior2017/raw/master/data-raw/fiscal_data.csv" target="_blank">here</a>.
 
 # Code examples
 
@@ -49,4 +51,13 @@ ggplot(fiscal_data, aes(x = factor(year), y = capag_il, color = state_calamity))
     guides(color=guide_legend(reverse=TRUE))
 ```
 
+<!-- Similarly, the estimation results for model 1 presented in table $4.2$ of @junior2017 can be reproduced with -->
+
+<!-- ```{r} -->
+<!-- library(brglm) -->
+
+<!-- fit <- brglm(spec_capag, family=binomial(link='logit'), data = DT) -->
+<!-- ``` -->
+
+
 # References

README.md

@@ -1,3 +1,6 @@
+Brazilian subnational governments fiscal data
+=============================================
+
 This package aims to make available in machine readable format regional
 discriminated data on the fiscal variables that are needed to compute
 the fiscal indicators used by the Brazilian National Treasury
@@ -14,7 +17,7 @@ This package can be installed directly from GitHub using `devtools`:
     devtools::install_github("fjuniorr/junior2017")
 
 Alternatively, a `csv` file with the dataset can be downloaded
-[here](https://github.com/fjuniorr/junior2017/raw/master/data-raw/fiscal_data.csv).
+<a href="https://github.com/fjuniorr/junior2017/raw/master/data-raw/fiscal_data.csv" target="_blank">here</a>.
 
 Code examples
 =============
@@ -42,6 +45,11 @@ reproduced with
 
 ![](README_files/figure-markdown_strict/unnamed-chunk-3-1.png)
 
+<!-- Similarly, the estimation results for model 1 presented in table $4.2$ of @junior2017 can be reproduced with -->
+<!-- ```{r} -->
+<!-- library(brglm) -->
+<!-- fit <- brglm(spec_capag, family=binomial(link='logit'), data = DT) -->
+<!-- ``` -->
 References
 ==========