[Roxygen-devel] Documenting data in data directory

[meik michalke]

hi,

Am Dienstag, 25. August 2015, 11:43:05 schrieb Rainer M Krug:
> 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---

first guess -- perhaps try:

 CACHE <- ""

instead.

second guess, if you would like to use the CACHE object defined in 
fileNames.R, try adding

 #' @include ../data/fileNames.R

to CACHE.R


viele grüße :: m.eik

-- 
  dipl. psych. meik michalke
  institut f"ur experimentelle psychologie
  abt. f"ur diagnostik und differentielle psychologie
  heinrich-heine-universit"at d-40204 d"usseldorf
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 836 bytes
Desc: This is a digitally signed message part.
URL: <http://lists.r-forge.r-project.org/pipermail/roxygen-devel/attachments/20150825/79c66c6d/attachment.sig>