Conversation
- Corrected typos and grammar in `R/model-run.R`, `R/make-data.R`, `R/predict.R`, `R/methods.R`, `R/generics.R`, `R/defaults.R`, and `R/utils.R`. - Clarified parameter descriptions, particularly for `init`, `.toggles`, `new_data`, and `past_data`. - Updated return value descriptions to be more specific, including class names where appropriate (`adrm`, `sdm`, `CmdStanGQ`). - Fixed incorrect documentation for `fit_sdm` toggles and `@seealso` links. - Standardized documentation for S3 methods and internal helper functions. - Addressed placeholder documentation in `R/defaults.R`. - Clarified `int_score` documentation regarding the `alpha` parameter. Co-authored-by: lcgodoy <24809942+lcgodoy@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
This pull request updates the
roxygen2documentation across several R files in thedrmrpackage.Changes include:
R/model-run.R: Fixed typos, clarifiedinitparameter options, and improved return value descriptions forfit_drmandfit_sdm.R/make-data.R: Corrected grammar in parameter descriptions and fixed typos in.togglesdocumentation. Removed inapplicable toggles frommake_data_sdmdocumentation.R/predict.R: Fixed typos and clarifiednew_dataandpast_datausage. Updatedpredict.sdmdocumentation to accurately reflect its arguments.R/methods.R: Cleaned up documentation for S3 methods (update,print,summary,draws), including removing duplicate author tags and fixing parameter descriptions.R/generics.R: Corrected the description ofsdminnew_sdm(Species Distribution Model).R/defaults.R: Replaced placeholder return value descriptions with meaningful text.R/utils.R: Improved return value descriptions and clarified thealphaparameter inint_score.These changes aim to improve the correctness, clarity, and conciseness of the package documentation. Note that the documentation (
man/files) needs to be regenerated usingroxygen2::roxygenize()as the environment did not support running R.PR created automatically by Jules for task 12729099472964578122 started by @lcgodoy