How to bug author
Want to share your content on R-bloggers? click here if you have a blog, or here if you don't.
As an author of several Bioconductor packages. I found many questions from users are quite annoying. Some of them never use google and they are reluctant to read vignettes.
Step 1: make sure you are using the latest release
I found many peoples are using out-of-date packages. When they got an issue of an out-dated package, they never check whether the issue still exists in latest release.
> rvcheck::check_bioc("clusterProfiler") package is up-to-date release version $installed_version [1] "3.0.4" $latest_version [1] "3.0.4" $up_to_date [1] TRUE
Step 2: read the vignettes
All Bioconductor packages contains a least one vignette and some of them are in very details. Most of the user questions can be solved if user go through the vignette carefully.
Step 3: ask google
I received several emails asking why my Bioconductor package is not available when they try to install it using install.packages()
.
If they google search the package name, they can reach the landing page of the package. Then they will find installation guide of using biocLite()
.
User question may already have an answer posted in Bioconductor support site, Biostars or somewhere. Just google search it before bugging the author.
Step 4: make a reproducible example
If there is indeed an issue exists in latest release and it is not documented in vignette and google can’t answer it, then you need to make a reproducible example for package author to reproduce your issue.
A question from ggtree
user is a good example. For more details, please follow the advice from http://adv-r.had.co.nz/Reproducibility.html or http://stackoverflow.com/questions/5963269/how-to-make-a-great-r-reproducible-example.
Then post the reproducible example on Bioconductor support site or Biostars tag with package name. Disucssion in public forum is useful since it may help other users.
R-bloggers.com offers daily e-mail updates about R news and tutorials about learning R and many other topics. Click here if you're looking to post or find an R/data-science job.
Want to share your content on R-bloggers? click here if you have a blog, or here if you don't.