roxygen2 Questions
1
Solved
I'm running a CMD check on a package in RStudio, part of which analyses the @examples in the inline Roxygen documentation.
I'm getting this error:
checking examples ... ERROR
Running examples in ...
1
Solved
I like the auto-comment feature Ctrl + /, but I'd like to be able the change the character it uses arbitrarily. I have read many similar questions like this one, but it's not exactly a generic solu...
Omaromara asked 14/6, 2017 at 21:43
1
Solved
I am developing a Shiny app at the moment and getting to a point with more functions than I expected. I plan to start automated testing with testthat and I would love to document my functions with ...
0
Disclaimer: I found the solution to this problem when writing this question. But my question now is "How does it work?"
I am trying to export S3 method from one package (say pkg.from) and import i...
2
Solved
I'm trying to document methods in the same file as the generic. I want the usage section to contain the method, but I do not want an alias generated for the method. This is because I have many meth...
1
I'm trying to create an R package but I keep getting the error:
Error in namespaceExport(ns, exports) :
undefined exports: MCLE, defineFunctions, naiveMLE
when running R CMD check on my packag...
1
The following MWE fails to compile (via devtools::document()):
#' MWE
#'
#' @examples
#' format('{}') # Works
#' format('{') # Nope
#' format('\{') # Nope
#' format('\\{')# Nope
format = function ...
1
Prior to updating to roxygen2 version 6.0.0, it appeared that the package supported using the @export tag not at the bottom of the function header in a package. For instance:
#' Title
#' @param fo...
Donaldson asked 8/2, 2017 at 14:59
1
Solved
FYI, looks like this question already has a LISP equivalent.
Recently I wanted to create a dataframe extension to the R base function setdiff and thought a generic would be nice. The following wor...
2
Solved
I have updated to roxygen2 v4.0.0 and am now attempting to convert @S3method and @method commands to @export commands following the directions here. This seems to have worked well for all of my met...
1
I am well aware of how to have roxygen not run an example when the code is directly in the roxygen comments. However, some example may be somewhat verbose or you would want you examples compiled in...
4
Solved
This question has been asked by another user on the RStudio help page here but has gone unanswered.
Basically, I've gone through all the steps:
(1) Installed Xcode
(2) Downloaded and installed...
1
Solved
I see that my recent package build no longer creates a manual even though I have not added "--no-manual" to the build settings. I didn't have this problem before - I have recently updated both devt...
1
Solved
According to the shortcuts help (Alt+Shift+K) the combination Ctrl+Shift+D should run the documentation routines. (This is also said in Section 5.1 of Hadley Wickhams "R packages" http://runsheng.g...
2
Solved
I am writing a package to facilitate importing Brazilian socio-economic microdata sets (Census, PNAD, etc).
I foresee two distinct groups of users of the package:
Users in Brazil, who may feel ...
Zugzwang asked 18/5, 2016 at 1:39
1
Solved
I'm documenting a function using roxygen2 with an @example.
The example has a string that contains a } symbol.
#' ...
#' @examples
#' \dontrun{
#' ## polyline joining the capital cities of Austr...
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
1
Solved
I have some data files that I want to distribute with a package I'm creating. I've placed the files in inst/extdata. How and where do I document these files using roxygen2?
Trickster asked 12/2, 2016 at 22:25
1
Solved
I'm writing an R package, and I'm documenting all of my functions with roxygen2. However, I do not want all functions to appear in the manual of the package. How can I specify which functions shoul...
Ambsace asked 4/3, 2016 at 17:0
1
Solved
I have a file: import_packages.r in my project, containing following:
#' @import reshape2
#' @import ggplot2
#' @import DESeq2
#' @import geneplotter
#' @import survcomp
#' @import gplots
#' @impo...
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...
4
Solved
Does RStudio support any automated roxygen template creation?
In Emacs-ESS, C-x C-o will produce an roxygen template for a function. For example, it will automagically convert this:
foo <- fu...
2
Solved
I'm working on the PKNCA package for R. While developing the testing code, some of the tests would also be good examples. I want to keep them as both (test and example). Is there a way that I can e...
2
Solved
I would like to include a Fortran subroutine in an R package. I have always only built packages using devtools and roxygen (so my knowledge may be pretty limited). I am getting an error that preven...
2
Actual question
How do I avoid Rd file name conflicts when
a S4 generic and its method(s) are not necessarily all defined in the same package (package containing (some of) the custom method(s) ...
© 2022 - 2024 — McMap. All rights reserved.