Passing LFMCMC object to functions and improve docs #64
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
gvegayon
changed the title
apulsipher
requested changes
Dec 16, 2024
apulsipher
added a commit
that referenced
this pull request
Dec 16, 2024
* First pass on enhancing the vignette * Polishing pass on LFMCMC vignette * Passing LFMCMC object to functions and improve docs (#64) * Adding missing element [skip ci] * Adding object to summary function * Adding class attribute * Renaming parameters and adding more info in the manual * Rename model param in example lfmcmc functions * Add tests to verify lfmcmc_obj in lfmcmc functions --------- Co-authored-by: Andrew Pulsipher <[email protected]> * Adding R to pre-commit * Typo in tests args (run_lfmcmc) --------- Co-authored-by: George G. Vega Yon <[email protected]>
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.
This pull request includes several updates to the
LFMCMCfunctions and documentation to improve clarity and consistency.Function Parameter Updates:
funs passed toset_*now receive the LFMCMC object itself.run_lfmcmc,set_observed_data, and other functions to remove trailing underscores for consistency (R/LFMCMC.R,inst/tinytest/test-lfmcmc.R,man/LFMCMC.Rd). [1] [2] [3]Documentation Enhancements:
LFMCMCdocumentation, specifying the expected input for each parameter (R/LFMCMC.R,man/LFMCMC.Rd). [1] [2]Test Case Modifications:
inst/tinytest/test-lfmcmc.R). [1] [2]Minor Fixes:
.Rbuildignoreto ensure the file is properly ignored (.Rbuildignore).These changes collectively improve the usability and maintainability of the
LFMCMCfunctions and their documentation.