2

I have an R file with several functions in the same file.

I was trying to document them using roxygen2, but roxygen2 only allows multiple files to be documented in the same help page in a weird way. Below example shows even though the two functions are documented separately, at the output help page all the comments are put under single Description page. Ideally I would have wanted to have separate help pages for each function, but that does not seem to be possible.

Is there a better way to reorganize the output so that there are multiple Description and Usage headings in the same page for each function.

#' comment a a <- function() { } #' comment b #' @rdname a b <- function( ) { }

This is the output

Improve this question
6
  • why are you doing @rdname a then Commented Mar 4, 2015 at 18:07
  • if I don't do @rdname I will not have b at help page Commented Mar 4, 2015 at 21:52
  • @rdname a says to put the docs for b in the same help file with a Commented Mar 4, 2015 at 23:12
  • ok but w/o rdname only a is documented. I also need b to be documented Commented Mar 5, 2015 at 8:58
  • that shouldn't happen. can you add the roxygen code or at least a sample from each section you added? Are you @export'ing these functions or just writing documentation? Commented Mar 5, 2015 at 15:31
Load 6 more related questions Show fewer related questions

0

Reset to default

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.