CODEWITHSUNDEEP
rroxygen2
Thomas Mailund
Thomas Mailund

Reputation: 1826

Documenting `..`

I'm trying to use roxygen to document and export a function I have named .. -- I use it for some pattern matching and want a name that doesn't take up much space in an expression but I don't want to clash with .

It simply looks like this:

#' Function for specifying a sequence of patterns/expressions
#'
#' This function is used when you want to test for more than one pattern
#' in parallel
#'
#' @param ... The patterns/expressions to combine
#'
#' @export
`..` <- function(...) structure(list(...), class = "..")

However, I get the error

Updating pmatch documentation
Loading pmatch
Skipping invalid path:  ...Rd 
Documentation completed

I guess that .. is not a name the man-pages for R likes, but is there any way to create documentation for this function? Or do I have to rename it?

Upvotes: 1

Views: 44

Answers (2)

Colin FAY
Colin FAY

Reputation: 5109

You can use : 

#' @rdname dotdot

Then it will create dotdot.Rd

Upvotes: 3

Thomas Mailund
Thomas Mailund

Reputation: 1826

Ah, the answer was simple. I just needed to give the function an explicit name using

#' @name `..`

then it works.

Upvotes: 1

Related Questions