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

Aimin Yan aimin.at.work at gmail.com
Fri Jun 9 17:08:26 CEST 2017


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]]



More information about the Bioc-devel mailing list