From Rainer at krugs.de  Tue Aug 25 11:43:05 2015
From: Rainer at krugs.de (Rainer M Krug)
Date: Tue, 25 Aug 2015 11:43:05 +0200
Subject: [Roxygen-devel] Documenting data in data directory
Message-ID: <m27fojsnyu.fsf@krugs.de>

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
-------------- 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/0b5132dd/attachment.sig>

From h.wickham at gmail.com  Tue Aug 25 13:58:00 2015
From: h.wickham at gmail.com (Hadley Wickham)
Date: Tue, 25 Aug 2015 06:58:00 -0500
Subject: [Roxygen-devel] Documenting data in data directory
In-Reply-To: <m27fojsnyu.fsf@krugs.de>
References: <m27fojsnyu.fsf@krugs.de>
Message-ID: <CABdHhvGPUk_gEHz2A2dwqZv1nqK05KyPZuyzhReW5VK9imo11A@mail.gmail.com>

You possibly don't have LazyData: true in your DESCRIPTION.
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



-- 
http://had.co.nz/

From Rainer at krugs.de  Tue Aug 25 14:56:21 2015
From: Rainer at krugs.de (Rainer M Krug)
Date: Tue, 25 Aug 2015 14:56:21 +0200
Subject: [Roxygen-devel] Documenting data in data directory
In-Reply-To: <CABdHhvGPUk_gEHz2A2dwqZv1nqK05KyPZuyzhReW5VK9imo11A@mail.gmail.com>
 (Hadley Wickham's message of "Tue, 25 Aug 2015 06:58:00 -0500")
References: <m27fojsnyu.fsf@krugs.de>
 <CABdHhvGPUk_gEHz2A2dwqZv1nqK05KyPZuyzhReW5VK9imo11A@mail.gmail.com>
Message-ID: <m2zj1fr0ga.fsf@krugs.de>

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>

From h.wickham at gmail.com  Tue Aug 25 14:59:02 2015
From: h.wickham at gmail.com (Hadley Wickham)
Date: Tue, 25 Aug 2015 07:59:02 -0500
Subject: [Roxygen-devel] Documenting data in data directory
In-Reply-To: <m2zj1fr0ga.fsf@krugs.de>
References: <m27fojsnyu.fsf@krugs.de>
 <CABdHhvGPUk_gEHz2A2dwqZv1nqK05KyPZuyzhReW5VK9imo11A@mail.gmail.com>
 <m2zj1fr0ga.fsf@krugs.de>
Message-ID: <CABdHhvE_B4hjpTjY4bqV117zk8epHseMC225W2Q=qZ=8V82GyA@mail.gmail.com>

Oooh, I didn't carefully read your data file - I don't think roxygen2
supports .R files in your data dir.  You'll need to do it by "hand",
ie.

#' location of cache
#'
#  Cache to be used for the computations
#'
#' @format Character vector of length one.
#' @name CACHE
#' @docType data
NULL

Hadley

On Tue, Aug 25, 2015 at 7:56 AM, Rainer M Krug <Rainer at krugs.de> wrote:
> 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



-- 
http://had.co.nz/

From Rainer at krugs.de  Tue Aug 25 15:06:35 2015
From: Rainer at krugs.de (Rainer M Krug)
Date: Tue, 25 Aug 2015 15:06:35 +0200
Subject: [Roxygen-devel] Documenting data in data directory
In-Reply-To: <CABdHhvE_B4hjpTjY4bqV117zk8epHseMC225W2Q=qZ=8V82GyA@mail.gmail.com>
 (Hadley Wickham's message of "Tue, 25 Aug 2015 07:59:02 -0500")
References: <m27fojsnyu.fsf@krugs.de>
 <CABdHhvGPUk_gEHz2A2dwqZv1nqK05KyPZuyzhReW5VK9imo11A@mail.gmail.com>
 <m2zj1fr0ga.fsf@krugs.de>
 <CABdHhvE_B4hjpTjY4bqV117zk8epHseMC225W2Q=qZ=8V82GyA@mail.gmail.com>
Message-ID: <m2vbc3qzz8.fsf@krugs.de>

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

> Oooh, I didn't carefully read your data file - I don't think roxygen2
> supports .R files in your data dir.  You'll need to do it by "hand",
> ie.
>
> #' location of cache
> #'
> #  Cache to be used for the computations
> #'
> #' @format Character vector of length one.
> #' @name CACHE
> #' @docType data
> NULL

OK - I'll do it like that.

Thanks,

Rainer

>
> Hadley
>
> On Tue, Aug 25, 2015 at 7:56 AM, Rainer M Krug <Rainer at krugs.de> wrote:
>> 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

-- 
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/865c8aba/attachment.sig>

From Meik.Michalke at uni-duesseldorf.de  Tue Aug 25 15:08:18 2015
From: Meik.Michalke at uni-duesseldorf.de (meik michalke)
Date: Tue, 25 Aug 2015 15:08:18 +0200
Subject: [Roxygen-devel] Documenting data in data directory
In-Reply-To: <m27fojsnyu.fsf@krugs.de>
References: <m27fojsnyu.fsf@krugs.de>
Message-ID: <1803626.3NXPr2X8g8@chiana>

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>