Re: [Bioc-devel] question regarding man pages

2016-03-03 Thread Hervé Pagès
e path is clear. Cheers, H. Dan - Original Message - From: "Krithika Bhuvaneshwar" To: "Kasper Daniel Hansen" Cc: "bioc-devel" Sent: Wednesday, March 2, 2016 2:18:14 PM Subject: Re: [Bioc-devel] question regarding man pages Thank you for the feedback - I

Re: [Bioc-devel] question regarding man pages

2016-03-02 Thread Dan Tenenbaum
Dan - Original Message - > From: "Krithika Bhuvaneshwar" > To: "Kasper Daniel Hansen" > Cc: "bioc-devel" > Sent: Wednesday, March 2, 2016 2:18:14 PM > Subject: Re: [Bioc-devel] question regarding man pages > Thank you for the feedba

Re: [Bioc-devel] question regarding man pages

2016-03-02 Thread Krithika Bhuvaneshwar
Thank you for the feedback - I have a follow up question (possibly a newbie question) So from what you are suggesting, the helper functions need not have man pages. I have to import some packages for the code to work in these helper functions. Before I used to have : #' @import(packageName) as pa

Re: [Bioc-devel] question regarding man pages

2016-03-01 Thread Kasper Daniel Hansen
Btw. a common (but not required) convention is that unexported helper functions start with . Personally I find that helpful. On Tue, Mar 1, 2016 at 8:20 PM, Kasper Daniel Hansen < kasperdanielhan...@gmail.com> wrote: > You only need to document functions which are exported in the NAMESPACE > fil

Re: [Bioc-devel] question regarding man pages

2016-03-01 Thread Kasper Daniel Hansen
You only need to document functions which are exported in the NAMESPACE file. R CMD check will clearly warn about missing documentation. I don't know how to deal with this in Rstudio. Best, Kasper On Tue, Mar 1, 2016 at 5:44 PM, Krithika Bhuvaneshwar wrote: > Hello, > > We are working on our

[Bioc-devel] question regarding man pages

2016-03-01 Thread Krithika Bhuvaneshwar
Hello, We are working on our first Bioconductor package and have a question regarding man pages for helper functions We have several .R files which are all helper functions. 1) I am using RStudio for package development, and it creates .Rd files for all my .R files including helper files. Do t