HighlanderLab / SIMplyBee

SIMplyBee R package extends AlphaSimR for simulating honeybee populations and breeding programmes
http://www.simplybee.info/
Other
0 stars 5 forks source link

Fixing tests and 2. CRAN issues #488

Closed janaobsteter closed 1 year ago

janaobsteter commented 1 year ago

This includes fixing examples BUT also buildUp and pullCastePop functions.

gregorgorjanc commented 1 year ago

@janaobsteter thanks for shortening examples. I kindly ask if you don't outright remove examples for non-exported functions, but use "dontrun" command - in this way we have an example to work with if we ever have to demonstrate, test or debug the function, etc.

Otherwise good to merge, but get those examples in first;)

janaobsteter commented 1 year ago

@gregorgorjanc , removing these examples was required by CRAN. They said either to export functions or remove the examples

gregorgorjanc commented 1 year ago

Your call, but I would prefer to have the code and "example" close - otherwise it will get lost or could drift away.

With regards, Gregor

On Fri, Dec 09, 2022 at 09:30:54, janaobsteter @.***> wrote:

@.**** commented on this pull request.

In R/Functions_L0_auxilary.R https://github.com/HighlanderLab/SIMplyBee/pull/488#discussion_r1044254270 :

@@ -2536,46 +2516,6 @@ getDronesCsdGeno <- function(x, nInd = NULL, dronesHaploid = TRUE,

'

' @return logical

'

-#' @examples

What if I create another file within R, put examples in it and put it in .Rbuildignore?

— Reply to this email directly, view it on GitHub https://github.com/HighlanderLab/SIMplyBee/pull/488#discussion_r1044254270, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAFRGSRUGGSWT4GTQZUIXJLWML345ANCNFSM6AAAAAASX3ASTE . You are receiving this because you were mentioned.Message ID: @.***>

janaobsteter commented 1 year ago

I'm thinking now - for the functions that we don't plan to ever export (combineBeeGametes), those examples will never get run. Maybe the solution is to put them in tests? I think that'd bee good. This way we keep and also still run the code to catch the bugs

gregorgorjanc commented 1 year ago

Cool compromise! merging this in.