[R] [Pkg-Collaboratos] BioShapes Almost-Package

Martin Maechler m@ech|er @end|ng |rom @t@t@m@th@ethz@ch
Mon Sep 4 13:30:16 CEST 2023

>>>>> Duncan Murdoch 
>>>>>     on Mon, 4 Sep 2023 04:51:32 -0400 writes:

    > On 03/09/2023 10:47 p.m., Jeff Newmiller wrote:
    >> Leonard... the reason roxygen exists is to allow markup
    >> in source files to be used to automatically generate the
    >> numerous files required by standard R packages as
    >> documented in Writing R Extensions.
    >> If your goal is to not use source files this way then the
    >> solution is to not use roxygen at all. Just create those
    >> files yourself by directly editing them from scratch.

    > Just a bit of elaboration on Jeff's suggestion -- here's
    > the workflow I prefer to using Roxygen.

    > Once you have a function that works:

    > 1.  install the package 2.  set your working directory
    > to the package "man" directory 3.  run
    > `prompt(functionname)` 4.  edit `functionname.Rd` in the
    > "man" directory, which will already be filled in as a
    > skeleton help file, with comments describing what else
    > to add.

    > Don't run prompt() again after editing, or you'll lose
    > all your edits.  But this is a good way to get started.

    > I think for the first few times the comments are really
    > helpful, but I wouldn't mind a way to suppress them.

    > Duncan Murdoch

Me neither.  A new option, not changing the default, would make sense.


More information about the R-help mailing list