Top "Roxygen" questions

Roxygen is an in-source documentation system for R. It is based on Doxygen, and is an alternative to creating .Rd files, in that it automatically creates the package's .Rd files from the in-source documentation.

generate markdown comments within for loop

I am trying to generate an HTML report, using knitr, based on an R script that has for loops. I …

r markdown knitr roxygen
When documenting in Roxygen: How do I make an itemized list in @details?

What is the appropriate syntax to add an itemized list to roxygen2, for instance, in the @details section? Can I …

r documentation roxygen
Roxygen2 - how to properly document S3 methods

I've read the Roxygen2 PDF as well as this site and I'm lost about the difference between @method @S3method @…

r roxygen roxygen2
How can I document data sets with roxygen?

Is it possible to include .R files in the data directory of my package in the roxygen process? I have …

r documentation-generation r-package roxygen
Does roxygen2 automatically write NAMESPACE directives for "Imports:" packages?

tl;dr version of my question If I want to import packages, do I have to manually write import() directives …

r roxygen roxygen2
Multiple functions in one .Rd file

Short version: Can I emulate the documentation of Normal in package stats using roxygen? Long version: I'm working on a …

r documentation package roxygen roxygen2
When writing my own R package, I can't seem to get other packages to import correctly

Alright, first attempt at writing an R package and I'm stuck. Here's how I create the package: package.skeleton("pkg",…

r import namespaces roxygen
How to properly document a S3 method of a generic from a different package, using Roxygen?

I am writing a package that defines a new class, surveyor, and a print method for this, i.e. print.…

r roxygen