https://stackoverflow.com/questions/9267584/when-documenting-in-roxygen-how-do-i-make-an-itemized-list-in-details
See last answer. It's not clear to me if you can have bulletted lists in
all of the sections of an Rd file or not, so it may be that the 'value'
section can't have bulletted lists. I don't see anything in the R-exts
manual that precludes it, however.
On Fri, Jun 9, 2017 at 11:08 AM, Aimin Yan <aimin.at.w...@gmail.com> wrote:
> I have a question about making R package documentation.
>
> I use rstudio to make this package. In my test.R file, I have code like the
> following:
>
> ...
>
> #' @return Returns a dataframe with several following variables (columns)
> #' \itemize{
> #' \item geneID: Gene ID
> #' \item geneWisePvalue: each gene is represented by the smallest
> p-value among its features
> #' \item sig.gene: a gene is significant (1) or not (0)
> #' \item mostSigDeFeature: the most significant gene feature
> #' \item numFeature: number of gene features within the gene
> #' }
>
> ...
>
> After rebuild, I get help documentation like the following:
> Value
>
> Returns a dataframe with several following variables (columns)
>
> -
>
> geneID: Gene ID
> -
>
> geneWisePvalue: each gene is represented by the smallest p-value among
> its features
> -
>
> sig.gene: a gene is significant (1) or not (0)
> -
>
> mostSigDeFeature: the most significant gene feature
> -
>
> numFeature: number of gene features within the gene
>
>
> Now, I want to get the following:
> Value
>
> Returns a dataframe with several following variables (columns)
>
> geneID: Gene ID
>
> geneWisePvalue: each gene is represented by the smallest
> p-value among its features
>
> sig.gene: a gene is significant (1) or not (0)
>
> mostSigDeFeature: the most significant gene feature
>
> numFeature: number of gene features within the gene
>
> That is to say, to create a a bulleted list without bullets.
>
> Does anyone has idea on how to change settings in test.R file?
>
>
> Thank you,
>
> Aimin
>
> [[alternative HTML version deleted]]
>
> _______________________________________________
> Bioc-devel@r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/bioc-devel
>
--
James W. MacDonald, M.S.
Biostatistician
University of Washington
Environmental and Occupational Health Sciences
4225 Roosevelt Way NE, # 100
Seattle WA 98105-6099
[[alternative HTML version deleted]]
_______________________________________________
Bioc-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/bioc-devel
