consider adding a few minor included datasets to the data dictionary

[cjyetman]

• related upkeep: Review and remove all TODO, FIXME, and any other comments used to kick cans down roads #213
• replaces inline todos removed in remove inline todos and replace with issue #276

A few inline todos in vignettes/cookbook_preparatory_steps.Rmd have been replaced by this issue.

There are a few minor included datasets that we should consider adding to the "Understanding the data" data dictionary vignette.

• ABCD data set columns: pacta.multi.loanbook:::cols_abcd
  

  pacta.multi.loanbook/R/expected_columns.R

  Lines 34 to 48 in 76e8cbd

  	# expected columns abcd file (raw and final)
  	cols_abcd <- c(
  	"company_id",
  	"name_company",
  	"lei",
  	"is_ultimate_owner",
  	"sector",
  	"technology",
  	"plant_location",
  	"year",
  	"production",
  	"production_unit",
  	"emission_factor",
  	"emission_factor_unit"
  	)

• target market share scenario data set columns: pacta.multi.loanbook:::col_types_scenario_tms[["cols"]]
  

  pacta.multi.loanbook/R/expected_columns.R

  Lines 9 to 20 in 76e8cbd

  	# expected columns tms scenario file
  	col_types_scenario_tms <- readr::cols_only(
  	scenario_source = "c",
  	region = "c",
  	scenario = "c",
  	sector = "c",
  	technology = "c",
  	year = "i",
  	smsp = "n",
  	tmsr = "n"
  	)
  	col_select_scenario_tms <- names(col_types_scenario_tms[["cols"]])

• SDA scenario data set columns: pacta.multi.loanbook:::col_types_scenario_sda[["cols"]]
  

  pacta.multi.loanbook/R/expected_columns.R

  Lines 22 to 32 in 76e8cbd

  	# expected columns sda scenario file
  	col_types_scenario_sda <- readr::cols_only(
  	scenario_source = "c",
  	region = "c",
  	scenario = "c",
  	sector = "c",
  	year = "i",
  	emission_factor = "n",
  	emission_factor_unit = "c"
  	)
  	col_select_scenario_sda <- names(col_types_scenario_sda[["cols"]])

• Raw loanbook columns: pacta.multi.loanbook:::col_types_raw[["cols"]]
  

  pacta.multi.loanbook/R/expected_columns.R

  Lines 125 to 141 in 76e8cbd

  	# expected columns raw loan book file
  	col_types_raw <- readr::cols(
  	id_loan = "c",
  	id_direct_loantaker = "c",
  	name_direct_loantaker = "c",
  	id_ultimate_parent = "c",
  	name_ultimate_parent = "c",
  	loan_size_outstanding = "n",
  	loan_size_outstanding_currency = "c",
  	loan_size_credit_limit = "n",
  	loan_size_credit_limit_currency = "c",
  	sector_classification_system = "c",
  	sector_classification_direct_loantaker = "c",
  	lei_direct_loantaker = "c",
  	isin_direct_loantaker = "c"
  	)
  	col_select_raw <- names(col_types_raw[["cols"]])

original inline todos:

pacta.multi.loanbook/vignettes/cookbook_preparatory_steps.Rmd

Lines 66 to 71 in 76e8cbd

	The ABCD data set must be an XLSX file and contains the following columns:
	```{r cols_abcd, echo = FALSE, results = 'asis'}
	# TODO: should this be in the data dictionary?
	cat(paste0("- `", pacta.multi.loanbook:::cols_abcd, "`", collapse = "\n"))
	```

pacta.multi.loanbook/vignettes/cookbook_preparatory_steps.Rmd

Lines 85 to 90 in 76e8cbd

	The target market share scenario data set must be a CSV file and contains the following columns:
	```{r cols_tms_scenario, echo = FALSE, results = 'asis'}
	# TODO: should this be in the data dictionary?
	cat(paste0("- `", names(pacta.multi.loanbook:::col_types_scenario_tms[["cols"]]), "`", collapse = "\n"))
	```

pacta.multi.loanbook/vignettes/cookbook_preparatory_steps.Rmd

Lines 94 to 99 in 76e8cbd

	The SDA scenario data set must be a CSV file and contains the following columns:
	```{r cols_sda_scenario, echo = FALSE, results = 'asis'}
	# TODO: should this be in the data dictionary?
	cat(paste0("- `", names(pacta.multi.loanbook:::col_types_scenario_sda[["cols"]]), "`", collapse = "\n"))
	```

pacta.multi.loanbook/vignettes/cookbook_preparatory_steps.Rmd

Lines 116 to 121 in 76e8cbd

	The raw loan books must be prepared as CSV files and contain at a minimum the following columns:
	```{r cols_raw_loanbooks, echo = FALSE, results = 'asis'}
	# TODO: should this be in the data dictionary?
	cat(paste0("- `", names(pacta.multi.loanbook:::col_types_raw[["cols"]]), "`", collapse = "\n"))
	```