Skip to content

[Bioc-devel] Question about creating a bulleted list without bullets in rstudio

3 messages · Aimin Yan, James W. MacDonald, Martin Morgan

Original
Aimin Yan
# 
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
James W. MacDonald
# 
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.work at gmail.com> wrote:

            

      
      
      
    

        

      
      
    

        

  
    

      
      
    

  


  


      

    

    

      
      

        


  

        

      Martin Morgan
    

    

      
      #
    

  


  

      
On 06/09/2017 11:08 AM, Aimin Yan wrote:

            

      
      
      
    

        
I looked at

https://github.com/wch/r-source/blob/trunk/src/library/stats/man/lm.Rd#L122

which leads me to

  #' @return
  #' \item{foo}{bar}

works.

Also, from RShowDoc("R-exts")

   \describe{
     \item{foo}{bar}
   }

might also be relevant in non-\value sections.

Martin

            

      
      
      
    

        

      
      
    

        
This email message may contain legally privileged and/or...{{dropped:2}}