roxygen2 Questions

2

Solved

I want to cite another package (the whole package, not just a function from it) in the documentation of some functions I'm developing. I am using Roxygen2 comments to document my package functions....
Championship asked 10/1, 2022 at 14:57

1

I am developing an R package (let's call it pkg), and I have defined a few generics. The NAMESPACE file contains both S3method(foo, bar) export(foo) However, upon calling pkg::foo.bar, I get the...
Pacheco asked 6/4, 2016 at 5:19

1

In a "R" package that uses roxygen2, I use a built-in data set in the example code I provide. When building and checking the package, I get Consider adding importFrom("datasets"...
Hodeida asked 16/6, 2016 at 15:51

14

Solved

I'm writing a function that uses an external data as follow: First, it checks if the data is in the data/ folder, if it is not, it creates the data/ folder and then downloads the file from github; ...
Metrist asked 19/10, 2017 at 19:25

1

So I'm writing an R package. Part of the essential documentation is the DESCRIPTION file. In this DESCRIPTION file there is a line where one must specify the Licensing of the package for CRAN-shara...
Hollyanne asked 28/4, 2020 at 16:0

3

Solved

I've set up and been regularly updating my R package to GitHub following Hadley's extensive documentation about Devtools, Roxygen2 etc., on my laptop. Yesterday I decided to use my main PC instead ...
Anacoluthia asked 1/11, 2016 at 16:13

2

Solved

I have the following file cumsum_bounded.cpp #include <Rcpp.h> using namespace Rcpp; //' Cumulative sum. //' @param x numeric vector //' @param low lower bound //' @param high upper bound /...
Chickadee asked 13/4, 2016 at 17:51

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?
Dennisedennison asked 5/2, 2014 at 13:16

5

Solved

I am wondering it there exists a method to link to function from other package when I'm trying to write a documentation for new package using roxygen2. Something like \link{pck=PACKAGE_NAME, fun=FU...
Exploratory asked 25/8, 2014 at 15:12

4

I am developing a package which has the function forecast.myclass. I want that function to work nicely with forecast package. I.e. when forecast package is loaded the code forecast(object) should c...
Bills asked 29/8, 2013 at 14:23

2

Solved

I'm making my first package rlandscape, using Roxygen2 and trying to follow the plain Roxygen vignette since Roxygen2 doesn't have one. As in the vignette (page 3), I created a file called rlandsc...
Abisha asked 2/3, 2012 at 18:34

2

Solved

I am writing R package documentation with roxygen2. I want to insert the following multiline equation into a help page, but my LaTeX code is not being rendered. #' hello2 #' #' @description #' \de...
Trivet asked 18/2, 2022 at 2:53

3

I am working with roxygen2 library and devtools. Building a package with the following structure: Inside /data folder I have two .rda files with the information of each dataset. Let's call them d...
Mertens asked 19/4, 2017 at 12:40

4

Solved

This question might be over-answered but I could not find one. Basically I am using RStudio and the keyboard shortcut cmd + shift + c for inserting comments. Is there an other combination to insert...
Proem asked 28/10, 2015 at 18:47

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

2

I am building a package and get an error, saying that a function is not an exported object of the package. In the R script, I have used @export tag to export the function, however when I roxigenise...
Vaccination asked 24/10, 2016 at 13:1

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...
Cutler asked 21/6, 2016 at 19:18

3

Some R packages (e.g., ggplot2, dplyr,devtools etc.) have alphabetically entitled sections in their help/documentation and a bar of links to those sections (indicated by red arrows in picture below...
Vivanvivarium asked 27/2, 2016 at 15:6

3

Is it possible to write documentation in R using non-ASCII characters (such as å, ä, ö) using roxygen2? I'm asking because I am writing an package with internal functions in Swedish. I have use th...
Infection asked 8/5, 2017 at 14:26

5

Solved

I'm writing a geocoding function right now that relies on having a Bing Maps Key. Obviously I'd rather not publish mine, and the examples fail without one. How do I include an example for users to...
Fluellen asked 20/8, 2012 at 12:59

5

When building a package, I got the error Error in namespaceExport(ns, exports) : undefined exports: FooBarBaz What does this mean, and how do I fix it?
Blockbuster asked 2/11, 2014 at 9:9

7

I am using Rstudio to streamline Sweave and R for data analyses that I will share with other analysts. In order to make the coding of variables crystal clear, it would be great to have something li...
Softhearted asked 20/9, 2013 at 18:23

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...
Willms asked 11/5, 2021 at 17:55

2

Solved

I like to keep my R packages up to date, and in developing my own package, I want to stick to @Hadley's advice: Generally, it’s always better to specify the version and to be conservative about ...
Tatty asked 3/8, 2016 at 8:26

2

I want to build a package with some functions i wrote. Now my problem is, that i cannot use the pipe-operator %>% with dplyr. I create the package with roxygen2. If i write the dplyr-commands wit...
Then asked 27/10, 2017 at 11:55

© 2022 - 2024 — McMap. All rights reserved.