roxygen2 Questions
1
Solved
I have already made a simple R package (pure R) to solve a problem with brute force then I tried to faster the code by writing the Rcpp script. I wrote a script to compare the running time with the...
1
Solved
I am trying to create the documentation of a few scripts that have some R6 classes in it. As an example I use the R6Class named "Person" from here: https://www.tidyverse.org/blog/2019/11/...
1
Solved
Inspecting dplyr shows there's both a README.md file and a README.Rmd file.
In the .md file, it says
README.md is generated from README.Rmd. Please edit that file
It's easy enough to create...
1
Solved
I am trying to document a new R project using roxygen2. I am using roxygen2 version 6.1.1 and desc version 1.2.0.
I have tried both the commands roxygen2::roxygenise() and devtools::document() but...
7
I don't know what is going on, everything was working great but suddenly I started to have this error message on the documentation:
Error in fetch(key) : lazy-load database '......descopl.rdb' i...
4
I am creating a package and for S3 methods I export them using
##' @method predict myclass
##' @export
predict.myclass <- function(object,...) { }
Now when I load the package, then predict wo...
2
Solved
I'm using \deqn{}{} with roxygen2 to document equations for a function in a package. The LaTeX (the 1st argument to deqn) renders fine because white space is ignored in LaTeX equations, but I have ...
2
Solved
I have an R package (not currently on CRAN) which defines a couple of S3 methods of generic functions from other packages (specifically knitr::knit_print and huxtable::as_huxtable). However, they'r...
2
Solved
I'm writing an R package and I want to include a table in an R help file, e.g. in the @details section. I tried including markdown code directly:
#' | Tables | Are | Cool |
#' | ------------- |:--...
1
Solved
I have a package with a function foo which uses rlang::fn_fmls() and rlang::fn_fmls()<-:
#' @importFrom rlang fn_fmls missing_arg
foo <- function(x) {
args <- rlang::fn_fmls(x)
args <...
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
2
Trying to build my first R package using roxygen2 and devtools. I have added a function that uses %>% and mutate in the @examples section. When I run check() it fails, because it cannot find the...
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...
2
Solved
I'm wanting to try using markdown in .Rd files.
I think I get that @md at the end of the documentation for a function makes it parse markdown. But not see this table appear, nor is the raw text app...
2
Solved
I am currently writing a function for an R package. Part of what this function is aimed to do is (a) take data as an input and (b) check one of its columns against a list of acceptable values.
The...
3
Solved
I'm a maintainer of a CRAN package and get the following messages when loading:
* checking whether package ‘qdap’ can be installed ... [10s/10s] WARNING
Found the following significant warnings:
...
2
Solved
I am working on an R package and I am using the package Roxygen2 to write the help manuals for my R functions. What I would like to know is if it is possible to use latex for math equations in the ...
1
Solved
I have some functions in a script that I would like to document those functions using #roxygen2, but the online resources have seen point towards documenting functions in a package. I do not want t...
3
So I'm trying to use roxygen2 to document my code. Unfortunately my supervisor felt it was cluttered having so many functions in the global environment. So I've been told to hide them away in sub e...
Alvinaalvine asked 10/7, 2018 at 14:43
1
Solved
I'm looking for an equivalent of @describeIn that will allow me to create a single documentation object for multiple R data objects.
I had hoped that something like this:
#' Tree Distances
#'
#'...
Jasmin asked 7/8, 2019 at 8:43
1
I would like to document an R function and inherit individual parameter documentation from other functions when multiple parameter names match. For example, lets say I have the following 2 function...
1
I'm writing my first R Package using devtools and roxygen2 in the RStudio IDE. The problem I have is related with previewing the .Rd files I get when I "roxygenize" the .R files. I'm using devtools...
Subinfeudate asked 2/9, 2016 at 12:59
2
Solved
I am writing a package but one persistent R CMD check warning prevents me from finishing the package and posting it to CRAN. I use roxygen2 for inline documentation, although that possibly isn't th...
2
Solved
I can do this easily with input parameters by having multiple lines of @param by doing as such:
#' @param var1 This is for x
#' @param var2 This is for y
#' @param var3 This is for Z
But how do ...
2
Solved
I'm writing an R package and want to inherit the documentation for two arguments (say x and y) from an old function (say old()) to a new function, new(). The twist is that these two arguments share...
Cautionary asked 29/9, 2016 at 5:55
© 2022 - 2024 — McMap. All rights reserved.