JRaviLab / MolEvolvR

An R Package for characterizing proteins using molecular evolution and phylogeny

https://jravilab.github.io/MolEvolvR/

Other

6 stars 16 forks source link

Add function documentation #97

Closed awasyn closed 3 weeks ago

awasyn commented 1 month ago

Document parameters

What kind of change(s) are included?

https://github.com/JRaviLab/MolEvolvR/issues/2
https://github.com/JRaviLab/MolEvolvR/issues/33
[x] Bug fix (fixes check).(devtools::document()) Should be cleaned when merged with: https://github.com/JRaviLab/MolEvolvR/pull/41
[x] Enhancement (documentation).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

[x] I have read and followed the CONTRIBUTING.md guidelines.
[x] I have searched for existing content to ensure this is not a duplicate.
[x] I have performed a self-review of these additions (including spelling, grammar, and related).
[x] I have added comments to my code to help provide understanding.
[x] I have added a test which covers the code changes found within this PR.
[x] I have deleted all non-relevant text in this pull request template.
[x] Reviewer assignment: Tag a relevant team member to review and approve the changes.

@the-mayer

awasyn commented 3 weeks ago

Thanks @the-mayer , sorry for the delay. I was finishing my final application for the internship. However i have recently tried to pass different examples and g[[x]] is empty every time. I'll add this clean up to my milestones. Error handling and refactoring the function..