roxygen 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
3
Solved
Below I posted a mini example in which I want do write documentation for
an “[“ method for a S4 class. Does someone know how to properly document a method for the generic "[" using roxygen and S4?
...
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
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
1
Solved
Consider a base package XYZ, written by someone else, which has a function ABC, I want to extend the functionality of ABC in my new (NOT XYZ) package via the following method.
ABC <- function(....
Sensuous asked 16/11, 2013 at 3:19
1
Solved
The way Roxygen seems to work is that the first line is the \title, everything else is in the \details, and then any @foo directives handle those things. But R documentation is richer than that. I ...
4
I just tried out Roxygen package. Within R, I can run through the example in the Roxygen Vignette. But In command line, R CMD roxygen is not recognized as a valid command. When I run R CMD --help, ...
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 ...
3
Solved
Other than the excellent SO answer here, and the Roxygen manual and vignette, is there any particularly thorough guide to using Roxygen?
Coquet asked 24/12, 2010 at 0:39
2
Alright, first attempt at writing an R package and I'm stuck. Here's how I create the package:
package.skeleton("pkg",code_files=some.filenames)
roxygenize("okg")
I'm using roxygen2 and have the...
Younger asked 25/4, 2012 at 23:29
2
Solved
I am making a package where I want to define a new method for plot. I am using roxygen in-source documentation. This question seems very similar to:
How to properly document a S3 method of a generi...
2
Solved
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:
/ mypacka...
1
Solved
I have a package for R I've been developing under Linux, and the horrible time has come where I'm testing it under Windows.
The documentation is done using roxygen, and I am using cygwin to build ...
1
Solved
I'm in the process of documenting some of my functions for an R package I'm making.
I'm using roxygen markup, though that is largely irrelevant to my question.
I have put equations into my document...
Lalise asked 21/2, 2012 at 6:37
1
Solved
I have a function that does nothing more than ads a unique attr to any R object. Base demo:
#' Setter function
#' @param x an R object
#' @param value a character value to set
#' @export
`foo<-...
Indisposed asked 15/1, 2012 at 21:29
1
Solved
Let's say I have a comment block where I'd like to write an email address. How would I go about escaping the "@" symbol so roxygen treats it as text instead of a directive?
1
Solved
tl;dr version of my question
If I want to import packages, do I have to manually write import() directives into my NAMESPACE file? It seems like roxygen2 won't magically do that for me, even if I ...
1
Solved
I'm working on a project right now where I have been slowly accumulating a bunch of different variables from a bunch of different sources. Being a somewhat clever person, I created a different sub-...
1
Solved
Is it possible to include an image in documentation generated by roxygen? I have a number of functions that are essentially wrappers for ggplot() that I'd like to document by showing an example of ...
2
Solved
I'm receiving an error from roxygenize() that I can't understand. I have a package of my miscellaneous functions in which the .Rd files are generated via roxygen.
The error is Error: titlerequires...
3
When writing a package in R, you can create the help pages in Rd format and then convert them into HTML pages. If the help page includes the example code, it is printed in Section "Examples".
For ...
© 2022 - 2024 — McMap. All rights reserved.