[WIP] Document all imported kinship functions

[Copilot]

• Add roxygen2 documentation for kinship2_alignped1 (pedigree alignment helper - processes single subject and spouses)
• Add roxygen2 documentation for kinship2_alignped2 (pedigree alignment helper - processes sibling groups)
• Add roxygen2 documentation for kinship2_alignped3 (pedigree alignment helper - merges two aligned pedigree structures)
• Add roxygen2 documentation for kinship2_alignped4 (pedigree alignment helper - computes optimal horizontal spacing)
• Add roxygen2 documentation for kinship2_bitSize (calculates bit size of a pedigree)
• Add roxygen2 documentation for kinship2_check.hint (validates kinship2 hints for consistency)
• Add roxygen2 documentation for kinship2_autohint (automatically generates alignment hints)
• Add roxygen2 documentation for kinship2_align.pedigree (main pedigree alignment function)
• Add roxygen2 documentation for kinship2_kindepth (calculates depth/generation of subjects)
• Fix typo in kinship2_bitSize error message (pegigree -> pedigree)
• All 9 kinship2 functions now have comprehensive roxygen2 documentation
• Ready for final validation

Summary

All kinship2 imported functions have been documented with roxygen2 comments:

• 9 functions documented
• 88 roxygen2 tags added
• All parameters and return values documented
• Functions marked as internal helpers
• Typo fix applied
• Documentation will be built by GitHub Actions R CMD check

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Need to document all the imported kinship functions</issue_title>
<issue_description>Need to document all the imported kinship functions. These are all named kinship2_FOO</issue_description>

<agent_instructions>Please help me document all of the kinship 2 files I'm working on. They need to work with roxygen</agent_instructions>

Comments on the Issue (you are @copilot in this section)

• Fixes Need to document all the imported kinship functions #88

---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.