Package: reportbrick 0.17.0

Robin Hasse

reportbrick: Reporting package for BRICK

This package contains BRICK-specific routines to report model results. The main functionality is to generate a mif-file from a given BRICK model run folder.

Authors:Robin Hasse [aut, cre], Ricarda Rosemann [aut]

reportbrick_0.17.0.tar.gz
reportbrick_0.17.0.zip(r-4.7)reportbrick_0.17.0.zip(r-4.6)reportbrick_0.17.0.zip(r-4.5)
reportbrick_0.17.0.tgz(r-4.6-any)reportbrick_0.17.0.tgz(r-4.5-any)
reportbrick_0.17.0.tar.gz(r-4.7-any)reportbrick_0.17.0.tar.gz(r-4.6-any)
reportbrick_0.17.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
card.svg |card.png
reportbrick/json (API)

# Install 'reportbrick' in R:

install.packages('reportbrick', repos = c('https://pik-piam.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/pik-piam/reportbrick/issues

On CRAN:

3.71 score 2 packages 10 exports 179 dependencies

Last updated from:0f4d2a98ee. Checks:7 NOTE, 2 OK. Indexed: yes.

Target	Result	Time
linux-devel-x86_64	NOTE	226
source / vignettes	OK	290
linux-release-x86_64	NOTE	228
macos-release-arm64	NOTE	152
macos-oldrel-arm64	NOTE	108
windows-devel	NOTE	147
windows-release	NOTE	140
windows-oldrel	NOTE	161
wasm-release	OK	164

Exports:checkMatching convGDX2MIF plotBRICKCalib plotMatching plotMatchingComparison readBrickSets reportCalibration showMatchingComparison showMatchingStandingStock showSankey

Dependencies:abind askpass backports base64enc bit bit64 boot broom bslib cachem callr car carData cellranger cli clipr collections colorspace commonmark corrplot countrycode cowplot cpp11 crayon credentials crosstalk curl data.table Deriv desc digest doBy dplyr evaluate farver fastmap filelock fontawesome forcats forecast Formula fracdiff fs gamstransfer generics gert ggplot2 ggpubr ggrepel ggsankey ggsci ggsignif gitcreds glue gms gridExtra gtable highr hms htmltools htmlwidgets httpuv httr httr2 igraph ini isoband jquerylib jsonlite kableExtra KernSmooth knitr labeling later lattice lazyeval lifecycle lme4 lmtest lubridate lusweave madrat magclass magrittr MASS Matrix MatrixModels memoise mgcv microbenchmark mime minqa mip modelr nlme nloptr nnet numDeriv openssl otel pbkrtest piamPlotComparison piamutils pillar pkgbuild pkgconfig pkgload plotly plyr polynom prettyunits processx progress promises ps purrr qualV quantreg quitte R.methodsS3 R.oo R.utils R6 rappdirs rbibutils RColorBrewer Rcpp RcppArmadillo RcppEigen Rdpack readr readxl reformulas rematch renv reshape2 rlang rmarkdown rprojroot rstatix rstudioapi S7 sass scales shiny sourcetools SparseM stringi stringr survival svglite sys systemfonts textshaping tibble tidyr tidyselect timechange timeDate tinytex trafficlight tzdb urca usethis utf8 vctrs viridisLite vroom whisker whoami withr writexl xfun xml2 xtable yaml ymlthis zip zoo

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
Add carrier dimension based on heating system technology	.addCarrierDimension
Aggregate	.agg
Check if the tolerance is violated anywhere	.checkForDeviation
All Combinations of dimension elements	.combinations
Compute the mean value in a data frame	.computeAvg
Compute the deviation to target data	.computeDeviation
Compute the sum of construction and renovation flow values	.computeFlowSum
Compute the ratio of the squares for two data sets	.computeRatioSq
Compute the relative deviation to calibration target data as the relative euclidean distance	.computeRelDev
Compute the sum	.computeSum
Compute the square root of the sum of the squares in a data frame	.computeSumSq
Construct dimension mapping (either aggregation or reporting) with explicit set elements for each dimension	.constructDimMapping
Escape tag in curly brackets	.embrace
Exclude data matching giving filter criteria from a data set	.excludeRows
Extend dimensions of a data frame by adding NA entries, add variable name	.expandDims
Find inconsistencies in set elements between reporting template and gdx	.findInconsistenSetElements
Find all tags in name escaped in curly brackets	.findTags
Get dimension names from stock and flow objects	.getDims
List any missing elements in any given dimension	.missingElements
Read a symbol from several gdx files and combine in one data frame	.readGdxIter
Replace column names 'bs' and 'hs' by 'bsr' and 'hsr'	.replaceVarName
select values from MAgPIE-obect	.select
Wrapper around setNames	.setNames
Split dimension names	.split
Check the matching results for inconsistencies	checkMatching
Read in GDX from BRICK and write *.mif reporting	convGDX2MIF
Crop MagPIE object to given periods and fill missing periods	extendPeriods
Render the BRICK calibration plotting routine	plotBRICKCalib
Matching reporting	plotMatching plotMatchingComparison
Read brickSets mapping	readBrickSets
Read symbol from gams container	readGdxSymbol
Report aggregated quantities	reportAgg
Report building Stock	reportBuildingStock
Read in model results from calibration for each iteration, calculate deviation	reportCalibration
Report construction	reportConstruction
Report demolition	reportDemolition
Report emissions	reportEmissions
Report energy demand	reportEnergy
Report renovation of heating systems	reportRenovation
Plot comparison between matching references and model values	showMatchingComparison
Plot share of initial heating systems removed	showMatchingStandingStock
Plot Sankey diagram	showSankey