In this PR, we fix several issues in the documentation:
Fixed such that internal no longer appears as an ... argument to explain() and explain_forecast().
Fixed so that the method-specific arguments in the ... documentation are in alphabetical order in explain(), explain_forecast() and explain_tripledot_docs(). The approaches are not alphabetically ordered in approaches, but that is okay. There, it makes sense to maybe put the best/ones we recommend first. Discuss with Martin.
Fixed an error in empirical.eta that removed half of a sentence from the parameter description.
Fixed that vaeac_get_data_objects() was exported but should have been an internal function.
I have fixed finalize_explanation() so that it no longer includes documentation from explain(), which should not be there. I have also added my name as a co-author, as I have the MSEv thing at the end of the function.
I fixed the prepare_data() documentation, which stated that internal was not used, which it is. Also, I added Martin's name as a co-author. Mine was the only name since I included my name in prepare_data.vaeac().
Fixed imports by removing the imports that are no longer used. Also, note that several more can be removed if one uses, e.g., data.table::copy instead of just copy. Currently, there is no consistency across methods when to include the library prefix and not. Discuss with @martinju. Also, sourceCpp is no longer needed, but removing it will cause the checks to give a lot of warnings. (This is PR #377)
Added plot_SV_several_approaches and plot_MSEv_eval_crit as main functions in the main vignette.
Added regression_separate and regression_surrogate in get_factor_approaches(), as they were missing and updated the corresponding snaps.
In this PR, we fix several issues in the documentation:
internalno longer appears as an...argument toexplain()andexplain_forecast()....documentation are in alphabetical order inexplain(),explain_forecast()andexplain_tripledot_docs(). The approaches are not alphabetically ordered inapproaches, but that is okay. There, it makes sense to maybe put the best/ones we recommend first. Discuss with Martin.empirical.etathat removed half of a sentence from the parameter description.vaeac_get_data_objects()was exported but should have been an internal function.finalize_explanation()so that it no longer includes documentation fromexplain(), which should not be there. I have also added my name as a co-author, as I have theMSEvthing at the end of the function.prepare_data()documentation, which stated thatinternalwas not used, which it is. Also, I added Martin's name as a co-author. Mine was the only name since I included my name inprepare_data.vaeac().data.table::copyinstead of justcopy.Currently, there is no consistency across methods when to include the library prefix and not. Discuss with @martinju. Also,sourceCppis no longer needed, but removing it will cause the checks to give a lot of warnings. (This is PR #377)plot_SV_several_approachesandplot_MSEv_eval_critas main functions in the main vignette.regression_separateandregression_surrogateinget_factor_approaches(), as they were missing and updated the corresponding snaps.