roxygen Questions
1
I'm writing a small convenience package for accessing a private API, and am using httr functions to conduct the requests. I'm also using Roxygen to handle documentation, etc. I'm importing httr fun...
1
Say I want to link to the "Details" section of my documentation for function foo, what do I do? \link{foo:Details} doesn't appear to work, so what is the right command?
2
Solved
I would like to use a directory structure within the R folder for the source code of a package. For example, within my R folder I have an algos folder with functions I want to export and document. ...
Dykstra asked 15/2, 2013 at 19:46
2
Solved
I imagine this is a simple thing that I keep overlooking in the documentation, but I can't seem to figure out how to get package-level documentation to work in R. I'm not referring to function or c...
2
Roxygen is inspired by the Doxygen documentation system that is used by C, C++ programmers. I have used Doxygen and I find it really easy to document any program as long as you have the doxygen com...
Queridas asked 20/5, 2016 at 4:39
3
Solved
I have documentation for R6Class:
#' Root component that don't have parent,
#'
#' It should not be used directly, only using \code{\link{pkg::component}} function.
#'
#' @name BaseComponent
#' @im...
2
I'm writing a package with an R6 class that has several methods. I would like to be able to generate documentation for both, class and methods. For the below example, I would like to be able to acc...
Macmahon asked 6/4, 2018 at 13:41
3
Solved
I'm learning to use roxygen. I see that the rd vignette advocates using "_PACKAGE" to indicate that I'm creating package documentation, and says "This also works if there’s already a function calle...
2
I'm refactoring a package that imports many other packages' full namespaces. I believe that many of these dependencies are used for single function call uses that would be better handled using impo...
2
Solved
I am building my own package, and I keep running into encoding issues because the functions in my package has non-english (non-ASCII) characters.
Inherently, Korean characters are a part of many of...
1
I am converting my packages to use roxygen documentation, through the roxygen2 package. Now my package does not load and I think that is is because of the missing useDynLib(mypackage) call missing ...
Chak asked 6/12, 2011 at 22:13
3
I am trying to add documentation via roxygen2 in a package. I am able to create the packag successfully and on load able to use the functions too. Here is my understanding of how to do it, I create...
3
Solved
I am writing a package that defines a new class, surveyor, and a print method for this, i.e. print.surveyor. My code works fine and I use roxygen for inline documentation. But R CMD check issues a ...
3
Solved
I've just started playing around with the roxygen package and I've very happy with the results so far. However I was wondering, is there a way to specify to roxygen that it should ignore certain fu...
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...
2
Solved
What is the appropriate syntax to add an itemized list to roxygen2, for instance, in the @details section? Can I create a latex list environment?
It seems that line breaks are simply ignored, i.e....
Kramer asked 13/2, 2012 at 20:32
5
Solved
I use Roxygen to generate Rd files of my packages under development, but I have some problems with functions with default parameter set to '\n', e.g.:
lineCount <- function(text, sep='\n') {
...
3
Solved
I am trying to generate an HTML report, using knitr, based on an R script that has for loops. I want to generate markdown comments from the comments within the for loop, but I am not sure if it's p...
2
Solved
The default value of a parameter of my function contains a "%". This seems to be a problem for roxygen, it produces a lot of warnings and R CMD check fails when trying to build latex documentation....
Southerland asked 2/4, 2010 at 10:21
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...
4
Solved
I'm updating an old package and shortening a bunch of really long function names. How do I let a user know the the old function has been deprecated? I document everything with roxygen2 so I'm wonde...
3
Solved
Is it possible to include .R files in the data directory of my package in the roxygen process?
I have put several .R files in the data directory. When they are sourced with data(), they read in ra...
Turley asked 22/2, 2010 at 11:3
1
Solved
I'm using roxygen to create my own package. I have a function that's causing a problem:
##' extract.sig.metadata
##' @param foo bar
##' @author me
##' @export
extract.sig.metadata <- function(f...
1 Next >
© 2022 - 2024 — McMap. All rights reserved.