search

rdinnager / slimr

Run and Analyse SLiM Population Genetics Forward Simulations from R.
https://rdinnager.github.io/slimr
Other
7 stars 1 forks source link

mainly documentation #69

Closed rdinnager closed 12 months ago

rdinnager commented 12 months ago

removed @examples because needs values some missing braces in documentation vignettes will not be accepted by cran (because need slim downloaded/installed. add as pdf and provide code seperately.

rdinnager commented 12 months ago

Hey @green-striped-gecko . Sorry it took me awhile to get to this. I think it looks good except I don't want to take out the '@examples'. I kept them there to remind me to write an example. CRAN has an 'ad-hoc' policy that all exported functions should have examples (see https://github.com/DavisVaughan/extrachecks, if you haven't seen this, it is pretty useful!). So we will have to write examples for these functions before we submit to CRAN. Also, by the way, I have created a 'release issue' for version 0.4.0 (https://github.com/rdinnager/slimr/issues/70), which we can aim to make the first CRAN release.

rdinnager commented 12 months ago

Hey @green-striped-gecko, I ended up incorporating most of your changes (except for the @examples removals) by syncing them into the new cran-release-0.4.0 branch. If you'd like to work more on the CRAN preparation, you can create a new branch based on cran-release-0.4.0 and the PR to that. Eventually I will start up a develop branch but maybe after the CRAN release is ready. I will close this PR now since the changes are incorporated elsewhere. Thanks for the help Bernd!