roxygen

I imagine this is a simple thing that I keep overlooking in the documentation, but I can't seem to figure out how to get package-level documentation to work in R. I'm not referring to function or class-specific documentation, but the documentation that you get when you type, for example, ?stats. I've followed the general instructions I've found on the web, creating a sckeleton documentation file saved as .R. The .R file is copied with the package scripts, but the help documentation doesn't get made into a .Rd file (unless I add a function definition also named after the package). An example of

I use Roxygen to generate Rd files of my packages under development, but I have some problems with functions with default parameter set to ' \n' , e.g.: lineCount <- function(text, sep='\n') { ... } Which purpose is to count new line ( '\n' ) characters in a string. The problem is that R CMD check gives a warning about: Codoc mismatches from documentation object 'lineCount': lineCount Code: function(text, sep = "\n") Docs: function(text, sep = " ") Mismatches in argument default values: Name: 'sep' Code: "\n" Docs: " " The problem seems to me that caused by writing to the Rd file (writing to

I'm working on developing an R package, using devtools, testthat, and roxygen2. I have a couple of data sets in the data folder (foo.txt and bar.csv). My file structure looks like this: / mypackage / data * foo.txt, bar.csv / inst / tests * run-all.R, test_1.R / man / R I'm pretty sure 'foo' and 'bar' are documented correctly: #' Foo data #' #' Sample foo data #' #' @name foo #' @docType data NULL #' Bar data #' #' Sample bar data #' #' @name bar #' @docType data NULL I would like to use the data in 'foo' and 'bar' in my documentation examples and unit tests. For example, I would like to use

I am writing a package that defines a new class, surveyor, and a print method for this, i.e. print.surveyor . My code works fine and I use roxygen for inline documentation. But R CMD check issues a warning: Functions/methods with usage in documentation object 'print.surveyor' but not in code: print I have used the following two pages, written by Hadley, as inspiration: Namespaces and Documenting functions , both of which states that the correct syntax is @method function-name class So my question is: What is the correct way of documenting the print method for my new class using Roxygen? And

I used 'package.skeleton()' to generate .Rd help files a few months ago. I have edited these files, and I have also changed the functions, removed some functions, added others. Is there a function that automates updating the Rd files? update A nice package was just released called Rd2roxygen , it is described by the author Yihui Xie on his blog . As the name implies, this package allows one to retroactively insert documentation currently contained in .Rd into .R files. Sounds like a promising approach for both learning roxygen and for converting packages currently in development to R packages.