Search
Question: warning: example doesn't exist; while trying to build a package
0
9 months ago by
clarisbaby0 wrote:

Hey everyone!!

I am trying to build a package for RNA-seq analysis combining different existing packages in bioconductor and am facing problem while trying to build and reload the package.

There is no error but a warning saying

testing.R:14: @example /home/disc/testing/fqcR() doesn't exist

I am using roxygen2 version 6.0.1 for documentation. there is no other error as such and the help file is also generated but no example is present.

Below is a part of testing.R script

#'@example
#'
#'fqcR()
#'

fqcR <- function ()
{
dir.create("results/Fastqc")
files <- list.files("data/", pattern =".fastq.gz", full.names = TRUE)

.

It would be very helpful if anyone could suggest, where I am going wrong and how to correct it.

modified 9 months ago • written 9 months ago by clarisbaby0
0
9 months ago by
shepherl ♦♦ 650
United States
shepherl ♦♦ 650 wrote:

I think it might be #' @examples (plural)

0
9 months ago by
Lluís R370
European Union
Lluís R370 wrote:

If the example is several lines long as it is your case, then you need to use @examples as pointed by shepheri.

Also make sure that you don't need a space after #' usually I have seen the code with #' (note the space after the '.

0
9 months ago by
clarisbaby0 wrote:

thanku so much shepherl and Lluis.... this worked!!! Just changing @example to @examples removed the warning