roxygen2 | Generate R package documentation from inline R comments

I am writing R package documentation with roxygen2. I want to insert the following multiline equation into a help page, but my LaTeX code is not being rendered.

I want to write a vignette explaining my R package. Inside the vignette, I want to explain one input to a certain function.

Basically, what I would write in the vignette is the same as I wrote in the @param section of the roxygen comments to my function.

To avoid writing the same things twice, is there a way that I can insert the roxygen2 description of a function input into a vignette?

I'm writing an R package using roxygen2 for documentation. I'm using the @includeRmd tag to reduce duplication, and this works well to generate consistent documentation across the help files, vignette, and pkgdown website.

My only issue is that, when I use the tag to insert examples, R CMD check gives me a nasty warning. Here is my setup:

R/adder.R ... source code for function with roxygen2 block

I want to cite another package (the whole package, not just a function from it) in the documentation of some functions I'm developing. I am using Roxygen2 comments to document my package functions.

I cannot find a way to create a link to a whole third-party package using Roxygen2. To link to a package function, one would write [pkg::fun()] but I don't know how to create a link to the package itself.

Some packages expose a general man page, and it's possible to link to it via e.g. [pkg::pkg].

But many packages don't have this and there's just a general package vignette with the list of functions and a link to the description:

Such page can be reached by clicking on a package name in the packages tab in RStudio.

How can I link to it from a function documentation made in Roxygen2 markdown.?

I am docummenting a dataset using roxygen2 (for my package development). I am trying to put cube meter (m^2) as a unit for one of my variable but it remains the same (m^2) when I am trying to see the documentation ?data. How can I generate units inside roxygen2?

Thank you

My colleagues and I routinely create ad hoc scripts in R, to perform ETL on proprietary data and generate automated reports for clients. I am attempting to standardize our approach, for the sake of consistency, modularity, and reusability.

In particular, I want to consolidate our most commonly used functions in a central directory, and to access them as if they were functions from a proprietary R package. However, I am quite raw as an R developer, and my teammates are even less experienced in R development. As such, the development of a formal package is unfeasible for the moment.

Fortunately, the box package, by Stack Overflow's very own Konrad Rudolph, provides (among other modularity) an accessible approach to approximate the behavior of an R package. Unlike the rigorous development process outlined by the RStudio team, box requires only that one create a regular .R file, in a meaningful location, with roxygen2 documentation (#') and explicit @exports:

Writing modules

The module bio/seq, which we have used in the previous section, is implemented in the file bio/seq.r. The file seq.r is, by and large, a normal R source file, which happens to live in a directory named bio.

In fact, there are only three things worth mentioning:

1. Documentation. Functions in the module file can be documented using ‘roxygen2’ syntax. It works the same as for packages. The ‘box’ package parses the
   documentation and makes it available via box::help. Displaying module help requires that ‘roxygen2’ is installed.

2. Export declarations. Similar to packages, modules explicitly need to declare which names they export; they do this using the annotation comment #' @export in front of the name. Again, this works similarly to ‘roxygen2’ (but does not require having that package installed).

⋮

At the moment, I am tinkering around with a particular module, as "imported" into a script. While the "import" itself works seamlessly, I cannot seem to access the documentation for my functions.

I am experimenting with box on a Lenovo ThinkPad running Windows 10 Enterprise. I have created a script, aptly titled Script.R, whose location serves as my working directory. My module exists in the relative subdirectory ./Resources/Modules as the humble file time.R, reproduced here:

I am refactoring an R package of another author (previous employee of my company). The author uses multiple variables in the roxygen2 examples that apparently are stored somewhere in the package. They are accessible with pkgname:::bar. I renamed some of these variables across the entire package to improve naming consistency, let's say the variable is called foo instead of bar now, but the examples are not running any more upon devtools::check(). The error: Error in get(name, envir = asNamespace(pkg), inherits = FALSE) : object 'foo' not found. However, I cannot find where they are defined. There are no objects in the data folder that would be named bar and searching for the variable name within all files (in RStudio and in Windows Explorer) does not reveal anything. Yet, pkgname:::bar still works. Any ideas where I should look for bar?

Im trying to set up a CI for a R package. In that regard I`m considering circleCI, which has worked out with previous R projects. However this time, I get the following error:

Is there a way to write roxygen2 tags for a function without devtools::document() saving Rd files? I like the roxygen2-style for internal documentation (for other developers) of stuff that will never concern the end user. Right now, the "unnecessary" rd files end up shipping with the package.

Ideally, something like a @noRd tag: