-
Notifications
You must be signed in to change notification settings - Fork 36
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
Closed
LHBO
wants to merge
18
commits into
NorskRegnesentral:shapr-1.0.0
from
LHBO:Lars/Fix_inheritDotParams
Closed
Update the manuals/documentation #391
LHBO
wants to merge
18
commits into
NorskRegnesentral:shapr-1.0.0
from
LHBO:Lars/Fix_inheritDotParams
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
…oach.empirical`.
…en an internal function.
…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
…urrogate' in the old version.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this PR, we fix several issues in the documentation:
internal
no 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.eta
that 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 theMSEv
thing at the end of the function.prepare_data()
documentation, which stated thatinternal
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 inprepare_data.vaeac()
.data.table::copy
instead of justcopy.
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)plot_SV_several_approaches
andplot_MSEv_eval_crit
as main functions in the main vignette.regression_separate
andregression_surrogate
inget_factor_approaches()
, as they were missing and updated the corresponding snaps.