roxygen2

I'm creating an R package that will use a single function from plyr . According to this roxygen2 vignette : If you are using just a few functions from another package, the recommended option is to note the package name in the Imports: field of the DESCRIPTION file and call the function(s) explicitly using ::, e.g., pkg::fun(). That sounds good. I'm using plyr::ldply() - the full call with :: - so I list plyr in Imports: in my DESCRIPTION file. However, when I use devtools::check() I get this: * checking dependencies in R code ... NOTE All declared Imports should be used: ‘plyr’ All declared

I am writing a script that uses roxygen2 to automatically roxygenize my package. I'd like it to be executable so that it can be part of a larger script to prepare and install the package, but I cannot make it work with Rscript for some reason. Here is the code: #!/usr/bin/env Rscript library(roxygen2) roxygenize('.', copy=FALSE) This works correctly if I start an interactive R session or if I submit the code using R CMD BATCH. However, I get this output and error if I run the script directly as an executable via Rscript (and I get the error regardless of whether the script is in the current

I am creating a package and for S3 methods I export them using ##' @method predict myclass ##' @export predict.myclass <- function(object,...) { } Now when I load the package, then predict works on object of the class myclass , but function predict.myclass is not exported. In the NAMESPACE I only get the entry S3method(predict,myclass) . So is there a way to export predict.myclass too, so that user will get the code of predict.myclass when he(she) writes predict.myclass in the console? My answer is "don't do that". The user can methods(predict); getAnywhere('predict.myclass') or mypackage::

I am trying to use a S3 method in a package and thought I understood how to set it up after asking a question here: S3 method consistency warning when building R package with Roxygen But now I get results I don't expect. If I run the code below directly in R it gives me the expected results but if I compile it into a package I don't get the correct results (notice the word the gets counted twice when it should take only unique words from vector a ). I'm not sure what I'm setting up incorrectly. The .R file: #' Find Common Words Between Groups #' #' Find common words between grouping variables

I'm using roxygen2 as a tool for documenting my R package, and I found that there is a @references tag in roxygen2, but that seems to only accept free form text. I found some presentation about roxygen which has tags @bibliograph and @cite, but am I correct that there is no such thing in roxygen2? Should I then somehow take the references out of the bibtex-file and write them manually with appropriate formatting directly after the @references tag or is there some more clever way of doing this? I have about seven different articles I need to cite, over multiple functions/rd-files. Seems that

I am struggling with the documentation of an R6 class and its methods. My goal is to get the autocompletion in RStudio for the methods. At the moment, I only get the name of the method but no the help information I normally get using roxygen2 documenting a function with parameters etc. At the moment, this is my class: #' @importFrom R6 R6Class MQParameters <- R6::R6Class( 'MQParameters', public=list( initialize=function(file_path=NA) { private$location <- file_path mq_parameters <- read.delim(file_path, stringsAsFactors=FALSE) mq_parameters <- setNames(mq_parameters$Value, mq_parameters

I create a new package with RStudio. In "Configure Build Tools", I check "Generate documentation with Roxygen". The first time I click on "Document" in the "Build" pane, everything works fine: ==> roxygen2::roxygenize('.', roclets=c('rd', 'collate', 'namespace')) First time using roxygen2. Upgrading automatically... Writing hello.Rd Writing NAMESPACE Documentation completed I get this NAMESPACE: # Generated by roxygen2: do not edit by hand export(hello) and this file hello.Rd : % Generated by roxygen2: do not edit by hand % Please edit documentation in R/hello.R \name{hello} \alias{hello}