search

Biometris / statgenGWAS

See https://biometris.github.io/statgenGWAS for a full description
https://biometris.github.io/statgenGWAS/
12 stars 3 forks source link

Please put a warning when covariates are present but not used #6

Open ne1s0n opened 2 years ago

ne1s0n commented 2 years ago

The runSingleTraitGwas() function ignores covariates present in the gData object if the "covar" argument is NULL (default). This is counterintuitive and at this point I had to correct three colleagues that thought the covariates were being used.

The best interface choice imho should be to use by default all the covariates present in the gData. If you want to keep the current behavior at least put a warning (or a message) specifying that covariates are present but not used, and to use the "covar" argument to select what to include in the model.

BartJanvanRossum commented 2 years ago

Thanks for your suggestion. I will discuss this with our internal users to see what their experience is with the "covar" argument and if a change in default behavior is needed.

A warning doesn't harm anyone, so that will definitely be added in the next version of the package.