Config file documentation #121
Merged
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 primarily updates and extends documentation for the
{ggpedigree}package, focusing on improving clarity, adding examples, and enhancing the user experience. The most significant changes include renaming and revising the configuration vignette to better describe its purpose, refining explanations and visual previews, and updating references to advanced examples in both R Markdown and HTML documentation. Additionally, a new vignette is introduced to demonstrate basic configuration usage.Documentation improvements and content updates:
vignettes/articles/v02_configuration.Rmdtovignettes/articles/v11_configuration_extended.Rmd, updating the title and index entry to clarify that it covers more uses of theconfigargument for controlling ggpedigree plots.configargument and its usage in plotting functions.code_unknownin the configuration example from0to3, reflecting an updated convention for unknown sex codes in pedigree plots.emoji_preview.png) and clarifying the differences in font rendering between preview and saved PNG outputs.vignettes/v10_configuration.Rto demonstrate setup, library usage, and basic pedigree plotting with the Potter dataset.Reference and formatting updates:
vignettes/v00_plots.Rmdandvignettes/v00_plots.htmlto indicate that these are available online to reduce package file size, improving the documentation’s clarity and relevance. [1] [2]These changes collectively make the documentation more user-friendly, accurate, and visually informative, especially for new users learning to configure and customize pedigree plots.