warning: example doesn't exist; while trying to build a package
3
0
Entering edit mode
clarisbaby • 0
@clarisbaby-14317
Last seen 3.5 years ago

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.

 

Thanks in advance

 

bioconductor package development R roxygen2 warning • 1.6k views
ADD COMMENT
0
Entering edit mode
shepherl 2.8k
@lshep
Last seen 35 minutes ago
United States

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

ADD COMMENT
0
Entering edit mode
@lluis-revilla-sancho
Last seen 1 day ago
European Union

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 '.

ADD COMMENT
0
Entering edit mode
clarisbaby • 0
@clarisbaby-14317
Last seen 3.5 years ago

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

ADD COMMENT

Login before adding your answer.

Traffic: 432 users visited in the last hour
Help About
FAQ
Access RSS
API
Stats

Use of this site constitutes acceptance of our User Agreement and Privacy Policy.

Powered by the version 2.3.6