roxygen2 Questions
1
Solved
For instance, say I have the following package called Test and I want to export class A:
# In /R/Test.R:
#' @docType package
#' @import methods
#' @exportClass A
A <- setRefClass("A", methods =...
Hexa asked 3/2, 2014 at 16:21
1
Solved
I have created a package named test and I have a function named lad inside it. When I build it and after check it with cran=TRUE, I receive the following error. Any idea what's going wrong?
* chec...
1
What is the way to format a call to importFrom while using roxygen2?
I can see two approaches:
importFrom base %in%
or
importFrom base `%in%`
Obviously we wouldn't import a base function i...
2
Actual question
How can I avoid that \dontrun{ in a separate file containing examples becomes \\dontrun{ in the respective Rd file after roxygenizing?
I did find a workaround, but feel as if I'm...
2
Solved
I've read the Roxygen2 PDF and this site, and I'm lost on the difference between @method @S3method @export and how to use these to properly document S3 methods. I worked up the follow example for d...
1
A simple example is that I have created an extension to show, which is a S4 base method. I don't want to cause a disambiguation fork by re-documenting show in my package, and I also want to consoli...
Melli asked 20/1, 2012 at 20:29
2
Solved
As a simple, concrete example:
#' Inverse Value Matching
#'
#' Complement of \code{%in%}. Returns the elements of \code{x} that are
#' not in \code{y}.
#' @usage x %nin% y
#' @param x a vector
#'...
2
Solved
Using roxygen2 documentation with devtools document function automatically generates a Collate: field in the package DESCRIPTION, regardless of whether or not it is necessary to load the package li...
Sarsaparilla asked 31/8, 2013 at 2:53
3
Solved
For documenting classes with roxygen(2), specifying a title and description/details appears to be the same as for functions, methods, data, etc. However, slots and inheritance are their own sort of...
2
Solved
Short version: Can I emulate the documentation of Normal in package stats using roxygen?
Long version: I'm working on a package and was trying make the documentation more readable by having a numb...
Sassaby asked 10/4, 2013 at 17:31
2
Solved
I am developing a package with roxygen2, that includes a number of lattice based visualizations. These are nice but not necessary for using the package, and therefore lattice is listed in the Sugge...
1
I am creating an R package, and found it useful to break parts of the logic in one file into internal helper functions, which I define in the same file. I have sort of a special case where my funct...
1
Solved
I am using roxygen2 from within RStudio to generate package documentation. How do I force the following in the @description section to appear as verbatim fixed-font?
SettingID Value
RedItem Patie...
1
Solved
whenever I run a Build & Reload from RStudio's Build pane, I get the message
==> Rcmd.exe INSTALL --no-multiarch rwiots
Error: contains a blank line
and, indeed, when I look, my DESCRIPT...
2
I have two methods for an S3 generic (defined in another package) that are closely related and so I wanted to document them in the same Rd file. However, when I document their arguments separately,...
Belda asked 10/4, 2012 at 19:55
2
Solved
I have taught a class in which I have had students use a package I have written. Now that the class is ending, I'd like to provide them the code for each of those functions inline with the document...
Friedly asked 3/3, 2013 at 15:53
1
Solved
Could someone provide an example of how to properly use the Template Tags in Roxygen2. I have tried to do the most obvious thing (to me):
In my packageName-package.R file:
#' [... other Roxygen ...
1
This is more of an annoyance than it is a problem, but is there any way to prevent the line "overflow" that occurs when documentation in R is compiled and a line is too long?
A snippet of some doc...
Carnahan asked 17/1, 2013 at 1:11
1
Solved
I am trying to use a S3 method in a package and thought I understood how to set it up after asking a question here: S3 method consistency warning when building R package with Roxygen
But now I get...
1
Solved
What's the recommended package build workflow with packages that contain S4 classes? [duplicate]
Possible Duplicate:
How to properly document S4 class slots using Roxygen2
I would like to build a package that contains S4 classes using R Studio and roxygen2.
I had already documen...
1
Solved
I ran into following problem already multiple times.
Say you have two classes, classA and classB described in the following files classA.R :
#' the class classA
#'
#' This is a class A blabla
#' ...
Portative asked 22/11, 2012 at 10:7
1
Solved
I created a package and pushed it up to github, such that the devtools function install_github() function works for easy installation. i.e. the github repo file structure is such that the DESCRIPTI...
1
Solved
I'm having trouble with checking assignment functions with Roxygen.
Here's a fairly minimal example:
#' Get sp feature IDs
#' @aliases IDs IDs.default IDs.SpatialPolygonsDataFrame IDs<- IDs<...
1
Solved
Suppose I have a function closure in my package, for example
f = function(x) {
x = x
g = function(y) x <<- y
h = function() x
list(g = g, h = h)
}
l = f(5)
l$g(10)
l$h()
What is the c...
Mckenziemckeon asked 23/10, 2012 at 9:50
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...
© 2022 - 2024 — McMap. All rights reserved.