-
Notifications
You must be signed in to change notification settings - Fork 20
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
document recHist #210
Comments
@hannesbecher I replied to this question #34 with an example that you can use/adapt-to-your-case as a starting point - you could lift and polish that explanation ... |
Cool thanks, did nt think to look into the closed issues, @gregorgorjanc. Where should this information best be moved to, a vignette? A documentation page? I guess both would be useful? @gaynorr ?
|
@hannesbecher this would be best handled by a vignette in my opinion and we have an open issue about this at #94 - I asked @AprilYUZhang to lead on this one, but I reckon we should all pul our shoulder to the wheel to make it happen. I see she started with some edits in AprilYUZhang@7971e9b, but we should move those to a separate independent vignette. Can you lead on this and pull @AprilYUZhang and me as needed and then @gaynorr will surely jump at some point in;) |
@hannesbecher yes, you have raised good points that should be mentioned in the vignette - how to specify recombination rate, map, marker vs bp level, distances, recHist! |
Is your feature request related to a problem? Please describe.
The recHist slot/property of the SimParam class is not documented/described, it seems.
Describe the solution you'd like
This is related to #94 of course, but as a start, it would be helpful to add a documentation page to the package explaining the nested structure of the recHist object.
Describe alternatives you've considered
#94
Additional context
An ASR simulation of tetraploids with 3 autosomes:
The 1st and 2nd chromosome of each set come from the same parent, I think. Which one is it, mother or father?
Feel fee to assign to me/ happy to send a PR.
The text was updated successfully, but these errors were encountered: