From jgrn at illinois.edu  Thu Aug 29 21:37:02 2013
From: jgrn at illinois.edu (Jonathan Greenberg)
Date: Thu, 29 Aug 2013 14:37:02 -0500
Subject: [Rd] Minimum requirements for package submission
In-Reply-To: <CABdHhvEB=CwtDLYJZippO3Baf=yFK1UOdOGDvwDkBD76H6JFUA@mail.gmail.com>
References: <CAPrRzuyMDh64qTw=DSEAunVfjG5AFY=aMHr5NrE9L+f5RmZNkw@mail.gmail.com>
	<CABdHhvGt184JfHZAw1k_GpGmiGgaK-XnCLqRofOvU9=WUgUuGw@mail.gmail.com>
	<CAKFxdiRjTE6avW9An2_X6HDV63f+Sv8LsO6FESrY0MzGKdHOLg@mail.gmail.com>
	<21022.2225.867873.997588@max.nulle.part>
	<alpine.DEB.2.00.1308281115520.22063@cardinals.dreamhost.com>
	<loom.20130828T225613-593@post.gmane.org>
	<alpine.DEB.2.00.1308281418290.8964@cardinals.dreamhost.com>
	<CAPrRzuzLJ5hWvfUquJeQ_iw8R+WAHvzZ1nGeiZHauyLf_3yrXg@mail.gmail.com>
	<CABG0rfuzXOfws6-yJxEQr=m8qLUrduY=MKo47Np8ZM=c2wwSgg@mail.gmail.com>
	<CABdHhvEB=CwtDLYJZippO3Baf=yFK1UOdOGDvwDkBD76H6JFUA@mail.gmail.com>
Message-ID: <CABG0rfso0hwq0RPccap=nORBY1nnP9S7yhpT_ygRJa+Ax9abhg@mail.gmail.com>

Ah, sorry -- I thought if I try to call a "hidden" function that has
not be exported (and, I thought, if it is exported, it needs to be
documented?), I have to call it via ::: ?

--j

On Thu, Aug 29, 2013 at 2:33 PM, Hadley Wickham <h.wickham at gmail.com> wrote:
> You only need ::: if you're calling it from another package (and see
> the lengthly recent discussion on that issue).  The key distinction is
> whether the function is exported or not: You must document any
> function that you export. You don't have to document any function you
> don't export.
>
> Hadley
>
> On Thu, Aug 29, 2013 at 2:15 PM, Jonathan Greenberg <jgrn at illinois.edu> wrote:
>> I had a similar question awhile ago.  Basically, my understanding is
>> if it is a function, it needs to be documented UNLESS you are calling
>> it via :::
>>
>> --j
>>
>> On Thu, Aug 29, 2013 at 1:11 PM, Sana Wajid <sat3lite at gmail.com> wrote:
>>> Thank you all, I appreciate your responses. Just a quick follow up
>>> question: couple of my functions are "background" or "behind the scenes"
>>> functions. Do these have to be documented in the manual as well?
>>>
>>>
>>> On Wed, Aug 28, 2013 at 5:19 PM, Geoff Jentry <geoffjentry at hexdump.org>wrote:
>>>
>>>> On Wed, 28 Aug 2013, Ben Bolker wrote:
>>>>
>>>>>  It may be suboptimal/there may be better ways, but what I would do in
>>>>> your situation would be to save the real twitteR results to a .Rdata file
>>>>> (e.g. put it in inst/vignetteData) and then 'fake' the twitter call: add a
>>>>> non-eval'd but echo'd chunk that appears to run the command, and an eval'd
>>>>> but non-echo'd chunk that loads the results of having run the command.
>>>>>
>>>>
>>>> Interesting, I'll look into doing that.
>>>>
>>>> Thanks
>>>> -J
>>>>
>>>>
>>>> ______________________________**________________
>>>> R-devel at r-project.org mailing list
>>>> https://stat.ethz.ch/mailman/**listinfo/r-devel<https://stat.ethz.ch/mailman/listinfo/r-devel>
>>>>
>>>
>>>         [[alternative HTML version deleted]]
>>>
>>> ______________________________________________
>>> R-devel at r-project.org mailing list
>>> https://stat.ethz.ch/mailman/listinfo/r-devel
>>
>>
>>
>> --
>> Jonathan A. Greenberg, PhD
>> Assistant Professor
>> Global Environmental Analysis and Remote Sensing (GEARS) Laboratory
>> Department of Geography and Geographic Information Science
>> University of Illinois at Urbana-Champaign
>> 607 South Mathews Avenue, MC 150
>> Urbana, IL 61801
>> Phone: 217-300-1924
>> http://www.geog.illinois.edu/~jgrn/
>> AIM: jgrn307, MSN: jgrn307 at hotmail.com, Gchat: jgrn307, Skype: jgrn3007
>>
>> ______________________________________________
>> R-devel at r-project.org mailing list
>> https://stat.ethz.ch/mailman/listinfo/r-devel
>
>
>
> --
> Chief Scientist, RStudio
> http://had.co.nz/



-- 
Jonathan A. Greenberg, PhD
Assistant Professor
Global Environmental Analysis and Remote Sensing (GEARS) Laboratory
Department of Geography and Geographic Information Science
University of Illinois at Urbana-Champaign
607 South Mathews Avenue, MC 150
Urbana, IL 61801
Phone: 217-300-1924
http://www.geog.illinois.edu/~jgrn/
AIM: jgrn307, MSN: jgrn307 at hotmail.com, Gchat: jgrn307, Skype: jgrn3007



[Rd] Minimum requirements for package submission
Jonathan Greenberg