Package development beginner here! I'm trying to turn some code into a local R package for the very first time. I made a package using usethis::create_package(), added documentation using devtool...

I am using devtools to build R package, and there are some functions that are NOT designed to be visible to end-users. However, since these functions involve calling C codes by .Call, so that I hav...

I'm using roxygen2 for my package description and I want to have mathematic equations in my documentation. For example I want to write n_{u} like a formula. When I write \eqn{n_{u}} in @details not...

I am trying to follow closely @hadley's book to learn best practices in writing R packages. And I was thrilled to read these lines about the philosophy of the book: anything that can be automate...

I have a problem about UTF-8. After conducting roxygen2::roxygenise() for my package, it showed the warning message 'roxygen2 requires Encoding: UTF-8'. How can I fix it? roxygen2::roxygenise() ...

I'm creating a R package that contains Rcpp functions depending on RcppArmadillo, so I first generate the package skeleton by RcppArmadillo.package.skeleton. However, when I roxygenize my package, ...

I am making an R package using devtools and roxygen2. I can get a PDF manual using R CMD but I am really curious as to whether this can be done using devtools. devtools' build(), check(), install()...

When writing an R package, I need to import another R package B. I use the roxygen2 for the documentation. My question is, if I have several R functions using the package B, should I write #' @...

So, I'd like to reference one of my package vignettes inside the roxygen2 comments of a function but I'm having a hard time understanding how to do it. More generally, how do we reference document...

I'm developing an R package where the functions fall into logical groups; broadly, "Input", "Data Munging", "Analysis", "Output", "Info", and "Utils". I want my package index to be split into these...

To generate an R documentation file (.Rd) I use the package RStudio/Document option with R 3.0.2, Linux 3.11, devtools 1.5, roxygen2 4.0.1. Objective I want to describe multiple arguments of a fu...

I am unable to generate .Rd documentation files for my package using RStudio and Roxygen2. First, let me mention that I have gone through similar problems posted here and have already done the foll...

I'm stuck with defining S3 method for autoplot. I have the following (full code here): #' Autoplot for bigobenchmark object #' #' @importFrom ggplot2 autoplot #' #' @param object #' #' @return A ...

automated data analysis workflows I have the following code in my packagename.R file in the packagename folder. I know I am going to use certain functions from other packages routinely, so I want ...

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

I'm trying to include a (somewhat) large dataset in an R package. I keep getting the Warning during the check in Rstudio saying that I could save space with compression: * checking data for ASCII ...

It is my first experience in writing an R-package. I used roxygen2 by following the instructions given in this link http://kbroman.org/pkg_primer/ Everythig is working fine except few things.. the...

I wrote an importer for an obscure TSV format, which I want to package and document: https://github.com/katrinleinweber/MWX-import/commits/package The importer function passes a renamed skip_lines...

In roxygen2, one can use the tag @inheritParams to inherit the full set of parameters of another function. But is it also possible to inherit only a certain subset of them? (Excluding the case of i...

Writing an R package, I have a R function that calls a specific Rcpp function. The Rcpp function just serves as a helper function and I do not want to creat a .Rd file for it. My solution so far is...

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

What is the correct way of roxygen documenting a function with an optional parameter like #' @name dbh2vol #' @usage dbh2vol(dbh,ipft) #' @description This is an allometric function to return the ...

I am eager to learn how to incorporate data examples as comments written above the functions, such as: ##' @examples ##' ## Set working directory... ##' ## Load data into R session: ##' data <...

I have a number of functions that have related methods with different arguments that I want to document together within the generic. Is there a standard method for documenting arguments passed thro...

Is there any way to generate documentation for a R shiny application? It becomes very hard to maintain a shiny application without documentation. It seems that all the eco-system of tests/docum...