Questions tagged [rd]

Use for questions related to the *documentation* of files written in R.

Rd format

R objects are documented in files written in “R documentation” (Rd) format, a simple markup language much of which closely resembles (La)TeX, which can be processed into a variety of formats, including LaTeX, HTML and plain text. The translation is carried out by functions in the tools package called by the script Rdconv in R_HOME/bin and by the installation scripts for packages.

The R distribution contains more than 1300 such files which can be found in the src/library/pkg/man directories of the R source tree, where pkg stands for one of the standard packages which are included in the R distribution.


Source: Writing R Extensions

61 questions
0
votes
1 answer

Writing roxygen documentation without saving .rd files?

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…
Jonas Lindeløv
  • 5,442
  • 6
  • 31
  • 54
0
votes
1 answer

@title Missing name at line 1

I was getting this error when running devtools::document but had no idea how to troubleshoot. The file that popped up on my installed package when I entered ?MyPackage-package did not match the text in MyPackage-package.R at all. I initially…
Michael Roswell
  • 1,300
  • 12
  • 31
0
votes
1 answer

Exported S3 method not found during check

In a package, I have a function foo that returns an object of class "foo". I also have a plot method for class "foo". #' Create a "foo" object #' #' @param x An \R object. #' #' @return #' A "foo" object. #' #' @examples #' foo_object <- foo(1) #'…
Mikael Jagan
  • 9,012
  • 2
  • 17
  • 48
0
votes
0 answers

Two R objects in .Rdata file in data/ folder R package?

I'm going through R CMD check WARNINGS and currently grappling with the below WARNING message: * checking for missing documentation entries ... WARNING Undocumented code objects: ‘diagnoses’ Undocumented data sets: ‘diagnoses’ Right now, I have…
lrthistlethwaite
  • 494
  • 2
  • 6
  • 23
0
votes
1 answer

Automatically call macro or insert template in every .Rd file

I am using roxygen to document an R package. I have a macro file, myMacro.Rd, in the "man/macros" subdirectory of the package. The file specifies the \myMacro macro. (The macro inserts a