[R-pkg-devel] Data docs

[Luis-Miguel Rodríguez Rojas]

Dear all,

I maintain a package that has data fields, and didn't have any problems
with this before. However, in my latest update, I'm getting the following
error message from the CRAN tests:

Flavor: r-devel-linux-x86_64-debian-gcc, r-devel-windows-ix86+x86_64
Check: for code/documentation mismatches, Result: WARNING
  Variables with usage in documentation object 'growth.curves' but not in
code:
    'growth.curves'

  Variables with usage in documentation object 'phyla.counts' but not in
code:
    'phyla.counts'

The variables are indeed NOT in the code, because they're only to be used
in the examples. In this version I moved my documentation from the old (now
defunct) inlinedocs to ROxygen2. In the previous form, I had to define a
structure in the code including both the function and the example, so
technically the code was using the variables. In the new form, I simply
define the examples with the @examples tag (that ends up in the .rd file
within an \examples{} block).

Does anyone have any idea on how I should define data in the code to avoid
this issue? I could simply add the example lines after the return (so
they're never reached), but that sounds like a horrible hack.

Just in case it's useful:
GitHub repository (inside the enveomics.R folder):
https://github.com/lmrodriguezr/enveomics/
Full test output:
https://win-builder.r-project.org/incoming_pretest/enveomics.R_1.5.0_20191026_032029/Windows/00check.log

Thanks!
Miguel.


--
Luis M. Rodriguez-R, Ph.D.
[ https://rodriguez-r.com ]
---------------------------------
Research Engineer
Georgia Institute of Technology
311 Ferst Drive, ES&T, Room 3324
Atlanta, GA 30332, USA
[ http://enve-omics.gatech.edu/ ]

	[[alternative HTML version deleted]]