Skip to content

Add trimming functionality and update related documentation#144

Open
smasongarrison wants to merge 15 commits intomainfrom
dev_main
Open

Add trimming functionality and update related documentation#144
smasongarrison wants to merge 15 commits intomainfrom
dev_main

Conversation

@smasongarrison
Copy link
Copy Markdown
Member

This pull request adds new functionality for identifying and removing leaf nodes from pedigree datasets, making it easier to clean and simplify pedigree structures. The main changes introduce two new functions—findLeaves and trimPedigree—along with their documentation and export statements. These functions help users iteratively prune pedigree data by removing individuals who do not affect the overall connectivity of the pedigree, with flexible options for customization.

New pedigree pruning functionality:

  • Added the findLeaves function, which identifies structural leaf nodes in a pedigree (terminal nodes and founder singletons), with options to protect individuals based on phenotype data and to control verbosity. (R/trimPedigree.R, NAMESPACE, man/findLeaves.Rd) [1] [2] [3]
  • Added the trimPedigree function, which iteratively removes leaf nodes from a pedigree until no more can be removed or a stopping condition is met. It supports user-specified removals, minimum size constraints, phenotype-based protection, and updates parent references after removal. (R/trimPedigree.R, NAMESPACE, man/trimPedigree.Rd) [1] [2] [3]

Documentation and exports:

  • Exported findLeaves and trimPedigree in the NAMESPACE file so they are available for users. [1] [2]
  • Added comprehensive Roxygen2 documentation and generated help files for both findLeaves and trimPedigree, including usage examples and detailed parameter explanations. (man/findLeaves.Rd, man/trimPedigree.Rd) [1] [2]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant