search

gaynorr / AlphaSimR

R package for breeding program simulations
https://gaynorr.github.io/AlphaSimR/
Other
43 stars 18 forks source link

Show in SimParam on how to access pedigree and recHist #53

Open gregorgorjanc opened 2 years ago

gregorgorjanc commented 2 years ago

Expand documentation in SimParam on how to access pedigree and recHist.

Happy to do it down the line;)

gaynorr commented 2 years ago

This might need something beyond the documentation that could or should be supported in SimParam. It probably makes sense to have documentation for developers and advanced users. I suggest hosting this documentation on the webpage. We can add documents like this to the webpage by adding Rmarkdown files to the folder /vigenettes/web_only. The pkgdown GitHub action will automatically include these in the webpage when they get pushed to the master branch. They won't be included in the package, because this folder has been added to the .Rbuildignore file.

gregorgorjanc commented 2 years ago

I agree with the approach!

@gaynorr Do you still want to keep the issue open as a reminder that we do this at some point?

gaynorr commented 2 years ago

I suppose we can keep it open as reminder.

gregorgorjanc commented 2 years ago

We can take the example from here https://github.com/gaynorr/AlphaSimR/issues/34