I want to insert a working link to a function in an R man page. When someone click it, it should execute the function. I?m using roxygen for packaging. Running the following code opens the help file from the package that I want to use instead of executing the function. I have tried the function with ?()? but it doesn?t work at all. Am I doing anything wrong?
#' @param heatmap.color a character string matches standard color names. The default value is "RdBu". "redgreen" is also very popular in genomic
#' studies. For the rest, please type
#' \code{\link[RColorBrewer]{display.brewer.all}}.
Best regards,
Arman
[Bioc-devel] Using function from another package in R documentation when using roxygen
2 messages · Arman Sh, Martin Morgan
On 05/27/2017 12:19 PM, Arman Sh wrote:
I want to insert a working link to a function in an R man page. When someone click it, it should execute the function. I?m using roxygen for packaging. Running the following code opens the help file from the package that I want to use instead of executing the function. I have tried the function with ?()? but it doesn?t work at all. Am I doing anything wrong?
#' @param heatmap.color a character string matches standard color names. The default value is "RdBu". "redgreen" is also very popular in genomic
#' studies. For the rest, please type
#' \code{\link[RColorBrewer]{display.brewer.all}}.
See https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Dynamic-pages but generally this doesn't seem like a good idea to me; maybe include in the example instead? Martin
Best regards, Arman [[alternative HTML version deleted]]
_______________________________________________ Bioc-devel at r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/bioc-devel
This email message may contain legally privileged and/or...{{dropped:2}}