screen_summary: Screening summary
In LBNL-ETA/RMV2.0: M&V2.0 Using R and Shiny
Description
Usage
Arguments
Value
Description
screen_summary This function is used by the shiny application
to perform a screening of the baseline models results
Usage
1
screen_summary(summary_tab, R2_trsh, CVRMSE_trsh, NMBE_trsh)
Arguments
summary_tab
a dataframe produced by train_model_summary function
R2_trsh
a numerical value corresponding to the R2 threshold
CVRMSE_trsh
a numerical value corresponding to the CV(RMSE) threshold
NMBE_trsh
a numerical value corresponding to the NMBE threshold
Value
a screen_summary object, which is a list with the following components:
- win_tab
a summary_tab dataframe containing only the results for the data files that passed the screening
- los_tab
a summary_tab dataframe containing only the results for the data files that did not passe the screening
- win_ratio
a numerical value corresponding to the ratio of data files that passed the screening
- los_ratio
a numerical value corresponding to the ratio of data files that did not passe the screening
LBNL-ETA/RMV2.0 documentation built on Nov. 9, 2020, 5:44 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Value
Description
screen_summary This function is used by the shiny application
to perform a screening of the baseline models results
Usage
1 | screen_summary(summary_tab, R2_trsh, CVRMSE_trsh, NMBE_trsh)
|
Arguments
summary_tab |
a dataframe produced by |
R2_trsh |
a numerical value corresponding to the R2 threshold |
CVRMSE_trsh |
a numerical value corresponding to the CV(RMSE) threshold |
NMBE_trsh |
a numerical value corresponding to the NMBE threshold |
Value
a screen_summary object, which is a list with the following components:
- win_tab
a summary_tab dataframe containing only the results for the data files that passed the screening
- los_tab
a summary_tab dataframe containing only the results for the data files that did not passe the screening
- win_ratio
a numerical value corresponding to the ratio of data files that passed the screening
- los_ratio
a numerical value corresponding to the ratio of data files that did not passe the screening
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.