documentation: draft all cookbook chapters

[jacobvjk]

• Title page/Intro/Context
• Preparatory steps
  • Which data sets are required as input?
    • Where/how to obtain external inputs
    • How to prepare own inputs (loan books and possibly sector classification)
    • Highlight which ones are required and which ones are optional
  • Installing relevant software
    • R, RStudio, this package, dependencies
  • file management (OPEN)
• Running the analysis
  • Structure of the flow of the analysis
  • Data prep (tbd)
  • Matching
    • Matching the loan books
    • Manual validation step
  • Prioritize and Diagnose (tbd)
    • Prioritizing the manually matched loans
    • Checking coverage and iterating in a smart way
    • misclassified loans (tbd)
  • Run main analysis
  • Generate Plots
• Interpretation of outputs
  • Types of results: coverage, PACTA
  • Sections for each
  • Example plots
  • Interpretation
  • Data dictionary
  • Mapping of dd to graph
• Advanced use cases (tbd)
  • How to handle regionally low coverage of real assets in the ABCD (to be confirmed)
  • ... (tbd)

Some notes:

• technically, there are no requirements here around project/folder structure. I wonder if we want top say anything about that nonetheless. Even if it were to be along the lines of: "You are free to store your input and output files wherever you want, as long as they are accessible within R"
• the exact content and structure of some of the sections depends on initial user feedback and will be scoped out in more detail later