RMI-PACTA / pacta.portfolio.report

pacta.portfolio.report
https://rmi-pacta.github.io/pacta.portfolio.report/
MIT License
1 stars 0 forks source link

Add minimal template #21

Open AlexAxthelm opened 9 months ago

AlexAxthelm commented 9 months ago

duplicate of https://github.com/RMI-PACTA/pacta.interactive.report/issues/218

Having a minimal template (placeholder text but including graphics) would allow us to test that the report generates successfully, and provide a framework for other organizations (who don't have access to https://github.com/RMI-PACTA/templates.transition.monitor) to build their own templates.

jdhoffa commented 3 months ago

Is this suitable: https://github.com/RMI-PACTA/pacta.portfolio.report/tree/main/inst/templates/general_en_template

Or would you prefer a minimal version of this? cc: @cjyetman ?

cjyetman commented 3 months ago

Is this suitable: https://github.com/RMI-PACTA/pacta.portfolio.report/tree/main/inst/templates/general_en_template

Or would you prefer a minimal version of this? cc: @cjyetman ?

that (or something like it) was the intent of the built-in template, to be used as a fallback if an external template was not available... but no, it's not "minimal" at all, it's just what GENERAL was at some point in the past

jdhoffa commented 3 months ago

Can you (when you have a moment) explain what you would minimally expect in such a template?

From the related issue, it sounds like a .Rmd with one single example for every possible visualization would satisfy the acceptance criteria?

cjyetman commented 3 months ago

I started a branch (apparently not pushed) that had a template for just the trajectory plot along with a few relevant stats. Idea was to be able to target a specific plot in testing just by choosing e.g. "test-trajectory-plot" as the initiative/project_name/template.

cjyetman commented 3 months ago

This was the ultra minified RMarkdown template file I was experimenting with as a testing template for the trajectory alignment plot:

---
pagetitle: "PACTA Climate Alignment Report"
params:
  portfolio_results_flag: TRUE
  real_estate_flag: FALSE
  survey_flag: FALSE
  survey_data: NULL
  re_config_data: NULL
  re_data_input: NULL
  portfolio_parameters: NULL
  rtyp: tn
  language: en
  tdm_results_flag: FALSE
output:
  bookdown::gitbook:
    mathjax: null
    css: "2dii_gitbook_style.css"
    toc_depth: 2
    split_by: "none"
    number_sections: TRUE
    config:
      fontsettings: false
      info: false
      sharing: false
---

# Volume Trajectory plot test

<div id="trajectory_alignment_equity" class="has_optbar donotremove">
</div>

<a href="export/environment_info.json">environment_info.json</a>

`r portfolio_parameters`