roxygen2 Questions
1
Solved
I'm using rogyxen2 template in my R package. As suggested, I added my template R files in a folder called "man-roxygen" in the package directory.
However, when I R CMD check I get the following no...
1
Consider the following R function definition, to be documented using roxygen2 (version >=5.0)
#' @title Test Bug
#' @author Daniel Egan
#' @param x
#' @return Nothing
#' @export
#' @examples
#' t...
1
In my RcppExports.R, things look like this:
# This file was generated by Rcpp::compileAttributes
# Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393
rcppeigen_ftrans <- function(A) {
.Cal...
1
Solved
Is there some mechanism by which I can transform the comments that roxygen sees, preferably before it does the roxygen->rd conversion?
For example, suppose I have:
#' My function. Does stuff with...
2
Solved
This question is very similar to this question but when I try the answer I receive an addition 'NOTE' following R CMD check. Although it is just a NOTE I would really like to have a completely clea...
1
Solved
it is probably bad style but can I modify options on package loading? E.g. my package should set the following options
options(java.parameters = "-Xmx8000m")
options(dplyr.width = Inf)
lattice.opt...
1
Solved
The Matrix package defines a whole bunch of S4 methods for multiplying matrices, that are dispatched by the S4 generic functions %*%, crossprod, and tcrossprod.
How do I import the "%*%" methods, ...
Barbel asked 6/11, 2014 at 15:56
0
This is my first time building an R package, and doing it with the help of devtools and roxygen2. After writing a simple func in the R directory and making a DESCRIPTION file with devtools, I try t...
1
Auto-documentation feature using roxygen2, while it is great and useful, it is annoying on every change of roxygen2 package version. It updates all my documentation files by putting roxygen2 versio...
1
Solved
I want to export an S3method named [.myclass using roxygen2 and I can't see a clean way to do this.
I need NAMESPACE to have
S3method("[",myclass)
in it or the method can't be used after I requ...
1
I have an R package that uses roxygen2. It has some C code in /src, and I have just started working with Doxygen. Are there any ways to combine the documentation or integrate compiling with r...
Carrolcarroll asked 20/12, 2013 at 23:24
1
I am writing an r package using roxygen2 for the documentation. I am having some trouble documenting S4 methods. I have defined a generic s4 method (e.g. myGeneric) and few methods that implement i...
2
Solved
Since roxygen2 version 4.0.0, the @S3method tag has been deprecated in favour of using @export.
The package now tries to detect if a function is an S3 method, and automatically adds the line S3met...
1
Solved
I'm trying to write my first R package. The functions in the package depend on the getURL() function from the RCurl package. I followed the tutorials on:
http://r-pkgs.had.co.nz/ and
http://hilaryp...
Barela asked 8/12, 2014 at 18:36
1
Let's say I am writing a small R package including two functions with exaclty the same arguments except one. Here is an example:
fct1 <- function(r, K){...}
fct2 <- function(r, p, K){...}
...
0
I'm developing a package in which multiple different functions have subsets of the same arguments. This means I have a lot of duplication of argument documentation. In many cases these functions ca...
2
Roxygen comments involve prefixing lines with #'.
When writing and testing examples for functions, it's nice to be able to toggle the comments on and off. I could copy and paste the code back and f...
1
I am building a package with Rcpp using Rstudio. Everything was working fine until I added the markup for documentation to my function file. I hope I am overlooking something obvious.
Here is my R...
1
Solved
When documenting a function with roxygen2 it is possible to place examples in a separate file.
See here: http://r-pkgs.had.co.nz/man.html
"Instead of including examples directly in the documentati...
2
Solved
I haven't quite figured out a sensible workflow for building packages and writing their documentation.
I want as much of the process (and the documentation) as possible to be automatically g...
Starspangled asked 21/6, 2010 at 15:41
1
Solved
Once I've seen a package supporting R program in which his documentation and reference manual was divided into chapters ( they were called by the consecutive letters of the alphabet ) so that an us...
Romalda asked 13/8, 2014 at 18:5
1
I have written a small package for my own use, and using devtools everything has gone very well. However, I tried to run R CMD Check on it, and got a number of errors, seemingly because my usage an...
1
Solved
When creating an R package, there are at least two alternatives for referencing functions in imported packages.
Either,
Explicitly name the function using the double colon operator whenever you ...
Jew asked 9/7, 2014 at 10:23
1
Solved
I have a function I am trying to document with roxygen2:
#' Name of function
#'
#' Description
#'
#' @param x The input data
#' @param method one of:
#' "method1" - very long text here
#' "meth...
2
Solved
I have 2 files, Rfile.R and Cppfile.cpp.
Contents in Cppfile.cpp:
#include <Rcpp.h>
using namespace Rcpp;
// [[Rcpp::export]]
int CPPF(int k){return ++k;}
Contents in Rfile.R:
RF<-fun...
© 2022 - 2024 — McMap. All rights reserved.