Re: [Bioc-devel] Passing BiocCheck with roxygen2 tags.

2020-06-25 Thread Erik Christensen 
Thank you! @return was the correct tag.

-Original Message-From: Mike Smith To: Erik 
Christensen Cc: bioc-devel Subject: 
Re: [Bioc-devel] Passing BiocCheck with roxygen2 tags.Date: Thu, 25 Jun 2020 
17:39:18 +0200
Hi Erik,
I think the #' @return tag will create the \value{} section in the Rd file.

Mike
On Thu, 25 Jun 2020 at 17:24, Erik Christensen  wrote:
> Hello,
> 
> 
> 
> Is there a way to add the value section in man pages using roxygen tags? I
> 
> am currently using "@section Value: ..." but this fails biocheck with
> 
> 
> 
> "WARNING: Add non-empty \value sections to the following...{{dropped:18}}
> 
> 
> 
> ___
> 
> Bioc-devel@r-project.org mailing list
> 
> https://stat.ethz.ch/mailman/listinfo/bioc-devel
> 


-- 
Erik Christensen 

[[alternative HTML version deleted]]

___
Bioc-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/bioc-devel

Re: [Bioc-devel] Passing BiocCheck with roxygen2 tags.

2020-06-25 Thread Mike Smith 
Hi Erik,

I think the #' @return tag will create the \value{} section in the Rd file.

Mike

On Thu, 25 Jun 2020 at 17:24, Erik Christensen  wrote:

> Hello,
>
> Is there a way to add the value section in man pages using roxygen tags? I
> am currently using "@section Value: ..." but this fails biocheck with
>
> "WARNING: Add non-empty \value sections to the following...{{dropped:18}}
>
> ___
> Bioc-devel@r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/bioc-devel
>

[[alternative HTML version deleted]]

___
Bioc-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/bioc-devel

Re: [Bioc-devel] Passing BiocCheck with roxygen2 tags.

2020-06-25 Thread Shepherd, Lori 
I think it's looking for details on the return value for the functions.  I 
believe the correct syntax is @return  to add a return value section in roxygen


Lori Shepherd

Bioconductor Core Team

Roswell Park Comprehensive Cancer Center

Department of Biostatistics & Bioinformatics

Elm & Carlton Streets

Buffalo, New York 14263


From: Bioc-devel  on behalf of Erik 
Christensen 
Sent: Thursday, June 25, 2020 11:24 AM
To: bioc-devel@r-project.org 
Subject: [Bioc-devel] Passing BiocCheck with roxygen2 tags.

Hello,

Is there a way to add the value section in man pages using roxygen tags? I
am currently using "@section Value: ..." but this fails biocheck with

"WARNING: Add non-empty \value sections to the following...{{dropped:23}}

___
Bioc-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/bioc-devel

[Bioc-devel] Passing BiocCheck with roxygen2 tags.

2020-06-25 Thread Erik Christensen 
Hello,

Is there a way to add the value section in man pages using roxygen tags? I
am currently using "@section Value: ..." but this fails biocheck with

"WARNING: Add non-empty \value sections to the following...{{dropped:18}}

___
Bioc-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/bioc-devel