Stack Overflow
Stack Overflow

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
2
votes
0 answers

\link[grDevices]{win.metafile} in Rd: how to pass R CMD check warning from a UNIX environment?

I'm working in a UNIX environment and making a package where an utility function's Rd needs to link to grDevices::win.metafile help page (that is Windows-specific). My .R file (using roxygen2) is #' Open a vectorial device file in a portable way. …
Luca Braglia
  • 3,133
  • 1
  • 16
  • 21
1
vote
1 answer

httpException 11481611 caused from bad url... how to fix?

In my event logs I am have an warning appear: Log Name: Application Source: ASP.NET 4.0.30319.0 Date: 10/24/2011 11:14:18 PM Event ID: 1309 Task Category: Web Event Level: Warning Keywords: …
user1014425
  • 11
  • 2
1
vote
1 answer

How to re-use item descriptions in Roxygen documentation?

I am documenting many data frames in an R package, either because they are returned by a function or they are included as data. Oftentimes, the same column/item needs to be described for many data frames. How can I avoid copy/pasting the same item…
larenite
  • 217
  • 1
  • 9
1
vote
1 answer

Conditional HTML entities in R documentation

I wish to include some non-ascii characters in the documentation for an R package, specifically the diacritic ă. I am using roxygen2, so must not include any non-ASCII characters in the .R file from which the documentation will be generated. …
Martin Smith
  • 3,687
  • 1
  • 24
  • 51
1
vote
1 answer

Documenting external data in R package for the inst/extdata folder?

I am working on a package in R, and am looking for a way to document the sources of external data stored in the inst/extdata folder. I know that data in the /data folder can be documented with roxygen as per this SO post. The trouble seems to be…
Rob
  • 265
  • 2
  • 11
1
vote
1 answer

Documenting a package that defines a function with the same name

I am writing a package named foo that defines an S3 class named foo with various S3 methods. I have written a constructor function foo() that returns a foo object. It seemed practical to name the class after the package, and the function after the…
Mikael Jagan
  • 9,012
  • 2
  • 17
  • 48
1
vote
0 answers

R package doumentation: overfull boxes for methods @family cross-references

I use roxygen2 to document my R package texreg. In the package, I define a generic S4 function called extract along with dozens of methods that enhance functionality from other R packages. In the documentation, I use the @family extract tag to…
Philip Leifeld
  • 2,253
  • 15
  • 24
1
vote
1 answer

Is there a way to convert Rd file online on github to pdf

I am trying to convert a Rd file to a Pdf so I can read it. This is the link to the Rd file: https://raw.githubusercontent.com/helske/walker/master/man/walker_glm.Rd I am new to R studio so please if there any package I need to load let me…
user5875780
1
vote
0 answers

Including images in R package documentation file

In fact, I have the same question than Teema Daniel Laajala, but the answer provided does not work for me. The question was about displaying images in R package documention. When I write exactly the same code than in the ?par documentation file,…
Julien
  • 11
  • 4
1
vote
1 answer

Document S4 class and "undocumented code object" during R CMD check

After struggling with documenting a S4 class with roxygen2, I decided to take a step back and create a minimum example using package.skeleton, promptClass, and promptMethod. My problem is that R CMD check still gives a warning about "undocumented…
user52366
  • 1,035
  • 1
  • 10
  • 21
1
vote
0 answers

Escaping hyphen in S4 method in Rd usage section in R package documentation

I wrote a method for a generic S4 function in R. The name of the generic function is extract. The class the method refers to has a hyphen in it, as in Zelig-tobit models. I'd like to write a documentation entry for the method as follows in the usage…
Philip Leifeld
  • 2,253
  • 15
  • 24
1
vote
0 answers

What is the .Rd encoding for @?

I'm trying to include some notes on LaTeX preamble requirements that will be needed to make certain options available in a package. I need to get the following to render correctly in the .Rd file, but I consistently get the error Error: Failure in…
Benjamin
  • 16,897
  • 6
  • 45
  • 65
1
vote
1 answer

ASCII equivalent to \eqn{\bar{x}} in Rd files

I am writing the documentation for a function of an R package I am building. In order to have a moderately nice aspect for the help file, I need the equivalent of \bar{x} in ASCII: \eqn{\bar{x}}{ASCII equivalent}
ralucaGui
  • 73
  • 5
1
vote
1 answer

LaTeX issue after compiling from Rd files

Apparently I've an issue after compiling few Rd files of an R package to LaTeX. It seems that pdftex cannot find Rd2 files to build the manual properly. The output is ok, but lacks the index. I'm running on a Macbook with 2013basic latex basic…
user3407340
  • 93
  • 1
  • 1
  • 4
0
votes
1 answer

How to change default location for storing Rundeck Projects

I am using Rundeck Docker Container. It was running well for 2 months and suddenly it crashed. I lost all the data wrt a project that I had created using CLI. Is there a way to change the default path to store all project related data including job…
mmg
  • 1
  • 2
1 2
3
4 5