Skip to content

[Bioc-devel] Usage of donttest{} in examples

2 messages · Fabricio de Almeida, Shepherd, Lori

Original
Fabricio de Almeida
# 
Dear Bioc developers,


I submitted a package 3 days ago and the build report returned TIMEOUT for Windows and macOS.

Then I included donttest{} in the example for a function that was taking too long to run, but now it is returning ERROR (http://bioconductor.org/spb_reports/cageminer_buildreport_20210709105948.html). See below:

    * ERROR: At least 80% of man pages documenting exported objects
      must have runnable examples. The following pages do not:
      mine_candidates.Rd, score_genes.Rd
    * NOTE: Usage of dontrun{} / donttest{} found in man page examples.
      14% of man pages use one of these cases.
      Found in the following files:
        mine_candidates.Rd
        score_genes.Rd


As you can see in the NOTE, these 2 functions represent 14% of the exported functions. Thus, 86% of the functions have runnable examples. Why is the build report saying that <80% have runnable examples?


Best regards,


=========================


Fabr?cio de Almeida Silva

Undergraduate degree in Biological Sciences (UENF)

MSc. candidate in Plant Biotechnology (PGBV/UENF - RJ/Brazil)

Laborat?rio de Qu?mica e Fun??o de Prote?nas e Pept?deos (LQFPP/CBB/UENF - RJ/Brazil)

Lattes CNPq: http://lattes.cnpq.br/3119358824056108

Personal website: https://almeidasilvaf.github.io/home/
2 days later
Shepherd, Lori
# 
We will look into the calculations for percentage to see if there is a bug in the reporting.


We encourage all functions to be adequately testing and run in actively executed code. Is it possible to scale down the example data set?  Often times it is feasible to show functionality of a function/package using a small or truncated data set rather than a complete set.

Cheers,


Lori Shepherd

Bioconductor Core Team

Roswell Park Comprehensive Cancer Center

Department of Biostatistics & Bioinformatics

Elm & Carlton Streets

Buffalo, New York 14263