How do you document multiple functions in a single man (.Rd) file, in package source?

Question

For example, I have a file foo.R with the contents:

#FILE: foo.R
foo <- function() "foo"
bar <- function() "bar"

This forms the R code for my package. I want to document both foo and bar in a single .Rd file: when the user enters help(foo) or help(bar), the result should be the same (to bring up the help page that documents both foo and bar). (Similarly, help(cos) and help(sin) result in identical behavior.)

Executing package.skeleton(name="pkg1", path="OUTDIR/", code_files="INDIR/foo.R") creates separate .Rd files for foo and bar in the "man" subdirectory.

How do I create a single .Rd file that documents both foo and bar, and that that help can find?

I am following Writing R Extensions, trying to create a very simple package without using any tools other than those that ship with a basic R installation (no Roxygen, for example), plus the system shell (e.g., bash or, in the present case, Windows command line, for executing e.g., R CMD build.)

an example [here](https://github.com/stla/OwenQ/blob/master/R/pOwen.R). — Stéphane Laurent, Sep 10 '19 at 15:22
Ah you don't want to use Roxygen ? Then see the compiled [Rd file](https://github.com/stla/OwenQ/blob/master/man/powen.Rd). — Stéphane Laurent, Sep 10 '19 at 15:26
@StéphaneLaurent What part of your [Rd file](https://github.com/stla/OwenQ/blob/master/man/powen.Rd) allows `help` to behave in the intended manner? — Ana Nimbus, Sep 10 '19 at 15:37
I don't master Rd files, I'm using Roxygen. But to reply to your question this is probably `\name` and `\alias`. — Stéphane Laurent, Sep 10 '19 at 15:39

How do you document multiple functions in a single man (.Rd) file, in package source?

0 Answers0