Show plot() usage in n_factors() examples#1205
Merged
strengejacke merged 3 commits intomainfrom Apr 14, 2026
Merged
Conversation
Agent-Logs-Url: https://github.com/easystats/parameters/sessions/ffe1fac9-e7bb-45d7-be07-e065b5a504f7 Co-authored-by: DominiqueMakowski <8875533+DominiqueMakowski@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add plot() method examples for n_factors
Show Apr 3, 2026
plot() usage in n_factors() examples
DominiqueMakowski
approved these changes
Apr 3, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates n_factors() documentation so users can discover and use the existing plot() method directly from the function examples, with the plotting example guarded on see being available.
Changes:
- Added a conditional
plot(result)example ton_factors()roxygen examples (guarded byrequire("see", quietly = TRUE)). - Regenerated
man/n_factors.Rdto match the roxygen example update. - Bumped the development version in
DESCRIPTIONfor this user-visible documentation change.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| R/n_factors.R | Adds a guarded plot() example to demonstrate the visualization workflow for n_factors() results. |
| man/n_factors.Rd | Syncs the rendered Rd examples with the roxygen update. |
| DESCRIPTION | Increments package version to reflect the documentation change. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or 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
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.
n_factors()documents that aplot()method exists via see, but the examples did not demonstrate it. This updates the examples so users can discover the plotting workflow directly from the function docs.Documentation
plot(result)example ton_factors()so the existing visualization method is shown alongsideas.data.frame()andsummary().seebeing installed.Generated docs
man/n_factors.Rdwith the roxygen change.Package metadata
DESCRIPTIONfor this user-visible documentation update.