rd Questions
2
I can use \item to make a list in .Rd files.
\item{blah}{blah}
But it seems that I can not create a nested list by put \item within another \item as in
\item{blah}{
\item{blah1}{some}
\item{bla...
2
Solved
To generate an R documentation file (.Rd) I use the package RStudio/Document option with R 3.0.2, Linux 3.11, devtools 1.5, roxygen2 4.0.1.
Objective
I want to describe multiple arguments of a fu...
0
What I have read
I have read this SO question and related answers but I am still a bit at loss of how to document a defunct function properly in my package.
What I have tried
I replaced the cod...
2
Solved
I'm trying to insert an equation in to an R documentation such that:
\deqn{p_{x}(1)=Pr(y=1|x)}
but it does come out as I expected where x is a subscript of p.
Does anybody know the reason OR ho...
Pearce asked 7/4, 2014 at 17:8
1
The following MWE fails to compile (via devtools::document()):
#' MWE
#'
#' @examples
#' format('{}') # Works
#' format('{') # Nope
#' format('\{') # Nope
#' format('\\{')# Nope
format = function ...
0
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 docume...
3
Solved
In conjunction with trying to find a solution for myself in regards to this question, I find myself plunged into trying to write valid Rd markup. What I want is to add a section named Raw Function ...
Littlejohn asked 4/3, 2013 at 4:53
2
Solved
I am new to roxygen and am struggling to see how to be able to use it to quickly create a new/custom package.
I.e. I would like to know the minimum requirements are to make a package called packag...
1
Solved
I am writing an R document (Rd) for functions. In markdown, we can create a hyperlink by [google](https://www.google.com). How can I replicate this in R document?
It seems that \link{...} can only...
1
Solved
I am working to document a visualization function in a package of mine. For this purpose I would like to have an image embedded through the Rd-file 'funcname.Rd' that could explain various paramete...
Boony asked 28/1, 2015 at 10:0
2
I'm trying to convert R documentation files (extension .Rd) into plain text. I am aware that RdUtils contains a tool called Rdconv, but as far as I know it can only be used from the command line. I...
2
Solved
My hyperSpec package provides functions to work with spectoscopic data sets. I provide hyperSpec-methods for quite a number of functions coming from other packages. However, some of these oth...
Hoopoe asked 21/8, 2012 at 15:28
1
I'm trying to document some datasets in an R package using roxygen2. Considering just one of these:
I have mypkg/data/CpG.human.GRCh37.RDa
which contains an object called CpG.human.GRCh37
and a f...
1
Solved
After reading questions such as this SO question on documenting a data set with Roxygen I have managed to document a dataset (which I will refer to as cells) and it now appears in the list generate...
1
Solved
In R, one very neat feature is that the source code of functions is accessible as objects in the workspace.
Thus, if I wanted to know the source code of, for example, grep() I can simply type grep...
2
Solved
how do I document the use of member functions of a reference class?
if I write a Rd file with a \usage block, how do I avoid the WARNING
Functions/methods with usage in documentation object 'XmlD...
Urinate asked 20/7, 2011 at 8:27
1
© 2022 - 2024 — McMap. All rights reserved.