Skip to content

Commit

Permalink
improve explanation on what to do with coverage diagnostics (#326)
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobvjk authored Dec 10, 2024
1 parent 7bb7aa1 commit fe3224d
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion vignettes/cookbook_running_the_analysis.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ If you want to apply the sector split to the loan books, you should keep all rel

The next step is to prioritize the manually verified matched loan books and analyze their coverage, both relative to the raw loan book inputs (the "match success rate") and to the production capacity in the wider economy (the "loan book production coverage"). Prioritizing the loan books means that you will only keep the best identified match for each loan and use that in the following steps of the analysis.

You will probably want to check the status of your loan book and production coverage several times, as it is rare to get to the desired level of matching in one iteration. This means you may want to repeat the previous step (matching the loan books, likely using different parameters for different iterations) and this step (prioritizing the matched loan books and analyzing their match success rate) a number of times to reach the best possible outcome. To prioritize your matched loan books and calculate the coverage diagnostics, you will use the `prioritise_and_diagnose()` function. This call will store matched prioritized loan book files and coverage diagnostics in a directory that you have indicated as the value corresponding to the key `dir_prioritized_loanbooks_and_diagnostics` in the `config.yml`. You can run the function as follows:
You will probably want to check the status of your loan book and production coverage several times, as it is rare to get to the desired level of matching in one iteration (see the corresponding ["Coverage Diagnostics" section](https://rmi-pacta.github.io/pacta.multi.loanbook/articles/cookbook_interpretation.html#coverage-diagnostics) in the next chapter for more details on how to interpret the coverage values). This means you may want to repeat the previous step ([matching the loan books](#matching-process), likely using different parameters for different iterations) and this step (prioritizing the matched loan books and analyzing their match success rate) a number of times to reach the best possible outcome. To prioritize your matched loan books and calculate the coverage diagnostics, you will use the `prioritise_and_diagnose()` function. This call will store matched prioritized loan book files and coverage diagnostics in a directory that you have indicated as the value corresponding to the key `dir_prioritized_loanbooks_and_diagnostics` in the `config.yml`. You can run the function as follows:

```r
pacta.multi.loanbook::prioritise_and_diagnose(config_path)
Expand Down

0 comments on commit fe3224d

Please sign in to comment.