search

xinhe-lab / ctwas

package for the causal TWAS project
https://xinhe-lab.github.io/ctwas/
MIT License
32 stars 12 forks source link

Remove help pages for non-exported functions #27

Closed pcarbo closed 3 months ago

pcarbo commented 3 months ago

I see that many of the help pages are for non-exported functions, which presumably means they should not be called by the user, e.g.,

library(ctwas)
help(read_pvar)

I understand if you may want some of these help pages for developer documentation, but in general it is confusing for the user, so it should be used sparingly (and if you want these help pages, they should be carefully flagged as "internal").

These help pages are being generated automatically by roxygen2 wherever you have the #' syntax. A simple solution is to replace #' with an ordinary comment # so that the help pages for these non-exported functions are not generated.

kevinlkx commented 3 months ago

Thanks Peter! I have updated the roxygen2 documentations with ordinary comment #