Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the manuals/documentation #391

Open
wants to merge 18 commits into
base: master
Choose a base branch
from

Conversation

LHBO
Copy link
Collaborator

@LHBO LHBO commented Apr 12, 2024

In this PR, we fix several issues in the documentation:

  1. Fixed such that internal no longer appears as an ... argument to explain() and explain_forecast().
  2. 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.
  3. Fixed an error in empirical.eta that removed half of a sentence from the parameter description.
  4. Fixed that vaeac_get_data_objects() was exported but should have been an internal function.
  5. 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.
  6. 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().
  7. 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 Update the imports #377)
  8. Added plot_SV_several_approaches and plot_MSEv_eval_crit as main functions in the main vignette.
  9. Added regression_separate and regression_surrogate in get_factor_approaches(), as they were missing and updated the corresponding snaps.

@martinju martinju mentioned this pull request Apr 16, 2024
@LHBO LHBO changed the title Update the manuals Update the manuals/documentation Apr 16, 2024
LHBO and others added 16 commits April 16, 2024 20:32
…comes in alphabetic order. The methods are not in alphabetic order in `approches` but that is okay for me. There it makes sense to maybe put the best/ones we reccomend first. Discuss with Martin.
…xplain()` which should not be there. (Also added my name a co author as I have the MSEv thing at the end of it)
…not used, which it is. Also added Martin's name as co-author. Mine showed up as the only name since I included my name in `prepare_data.vaeac()`.
Added "'regression_separate'" and "'regression_surrogate'" as factor approaches (they were missing). And fixed some typos
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant