[Roxygen-devel] Documenting data in data directory

[Rainer M Krug]

Hadley Wickham <h.wickham at gmail.com> writes:

> You possibly don't have LazyData: true in your DESCRIPTION.

Thank - I had

LazyData: yes

and now I have

LazyData: true

but I still get the same error message?

Rainer

> Hadley
>
> On Tue, Aug 25, 2015 at 4:43 AM, Rainer M Krug <Rainer at krugs.de> wrote:
>> Hi
>>
>> I am trying to document data which is defined in a file named
>> ./data/fileNames.R which looks as follow:
>>
>> --8<---------------cut here---------------start------------->8---
>> CACHE <- file.path( getwd(), "cache")
>> SQLITEDB  <- file.path(CACHE, "energyBalance.sqlite")
>> --8<---------------cut here---------------end--------------->8---
>>
>> But I am struggling with documenting it.
>>
>> It seems that when I put the
>>
>> I have the following documentation for CACHE in the file ./R/CACHE.R:
>>
>> --8<---------------cut here---------------start------------->8---
>> #' location of cache
>> #'
>> #  Cache to be used for the computations
>> #'
>> #' @format Character vector of length one.
>> #'
>> "CACHE"
>> --8<---------------cut here---------------end--------------->8---
>>
>> But I get the following error when running roxygenise():
>>
>> ,----
>> | Error: Failure in roxygen block beginning CACHE.R:1
>> | object 'CACHE' not found
>> `----
>>
>> Any suggestions how I can document each data variable?
>>
>> Thanks,
>>
>> Rainer
>>
>> --
>> Rainer M. Krug
>> email: Rainer<at>krugs<dot>de
>> PGP: 0x0F52F982
>>
>> _______________________________________________
>> Roxygen-devel mailing list
>> Roxygen-devel at lists.r-forge.r-project.org
>> https://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/roxygen-devel

-- 
Rainer M. Krug, PhD (Conservation Ecology, SUN), MSc (Conservation Biology, UCT), Dipl. Phys. (Germany)

Centre of Excellence for Invasion Biology
Stellenbosch University
South Africa

Tel :       +33 - (0)9 53 10 27 44
Cell:       +33 - (0)6 85 62 59 98
Fax :       +33 - (0)9 58 10 27 44

Fax (D):    +49 - (0)3 21 21 25 22 44

email:      Rainer at krugs.de

Skype:      RMkrug

PGP: 0x0F52F982
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 480 bytes
Desc: not available
URL: <http://lists.r-forge.r-project.org/pipermail/roxygen-devel/attachments/20150825/16ce1e25/attachment.sig>