A few issues that I remember running into recently

[hassaniazi]

District heat:

The package throws the following error when you query Secondary Energy* regions that don't have district heat. DH is only available in 4 regions in GCAM.

> Loading data, performing checks, and saving output...
> [1] "secondary_energy_clean"
> Error in rgcam::getQuery(prj, "district heat production by subsector (fuel)") : 
>   getQuery: Query district heat production by subsector (fuel) is not in any scenarios in the data set.

I wonder if queries or the criteria could be determined dynamically.

Or a mechanism to relax the hard stop.

My workaround was to put a region (China, Russia etc) that has DH for it to bypass the hard stop.

[hassaniazi]

UI:

If you don't git clone and run from within the package, the UI doesn't work

Launching UI...
Error in `shinyAppDir()`:
! No Shiny application exists at the path "inst/gcamreport_ui"

which makes sense because my installation shows the UI folder in the root

ls /Library/Frameworks/R.framework/Versions/4.5-arm64/Resources/library/gcamreport 
data		gcamreport_ui	INDEX		NAMESPACE
DESCRIPTION	help		LICENCE		NEWS.md
extdata		html		Meta		R

[hassaniazi]

version:

even though I have specified GCAM_version <- "v8.2", the output file still writes GCAM 7.1 in the Model column. I also see v7.1 hard coded in the package code files

[hassaniazi]

GCAM_version:

GCAM_version has to be specified globally, not as an argument to the generate_report() function.

This is still true: #36

[hassaniazi]

World vs a region:

Even though I have specified a couple regions, the outputs reports an extra "World" region, which isn't really world, but just a row copy of my region. The rows seem to be duplicated

[hassaniazi]

Ukraine:

GCAM v7.1 was the Ukraine breakout. But Ukraine isn't supported as a region.

Error in generate_report(db_path = dbpath, db_name = dbname, scenarios = scen,  : 
  The desired region Ukraine is not available for reporting. Please check the available regions by running `available_regions()` in your console.

[hassaniazi]

It is very much possible that I have been using it all wrong. Sorry in that case and please correct me. I thought it may be useful to document some of the things I ran into as a freshie to the package whose sole entry point is just the package documentation. Barring my observations, this is awesome and so helpful!! Thanks for putting it together!

[hassaniazi]

Oh and relative paths don't work

e.g., I couldn't do dbpath <- "../../output"