Search
Question: warning: example doesn't exist; while trying to build a package
0
gravatar for clarisbaby
11 months ago by
clarisbaby0
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.

 

Thanks in advance

 

ADD COMMENTlink modified 11 months ago • written 11 months ago by clarisbaby0
0
gravatar for shepherl
11 months ago by
shepherl ♦♦ 830
United States
shepherl ♦♦ 830 wrote:

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

ADD COMMENTlink written 11 months ago by shepherl ♦♦ 830
0
gravatar for Lluís Revilla Sancho
11 months ago by
European Union
Lluís Revilla Sancho400 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 '.

ADD COMMENTlink modified 11 months ago • written 11 months ago by Lluís Revilla Sancho400
0
gravatar for clarisbaby
11 months ago by
clarisbaby0
clarisbaby0 wrote:

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

ADD COMMENTlink written 11 months ago by clarisbaby0
Please log in to add an answer.

Help
Access

Use of this site constitutes acceptance of our User Agreement and Privacy Policy.
Powered by Biostar version 2.2.0
Traffic: 346 users visited in the last hour