[ESS] Best Practice for building R packages
Tyler Smith
ty|er @end|ng |rom p|@nt@rum@c@
Thu Oct 8 15:38:31 CEST 2020
I only update my package once or twice a year, and haven't created
a new one in a while. That said, I really like the ESS/devtools
integration. I usually have to dig into the docs to remind myself
about `C-c C-o C-o` to get a new roxygen template, but that's much
less effort than refreshing myself on Rd syntax (again).
I didn't realize ESS automated compiling documentation! devtools'
`document()` function is what I've been using, and I hadn't
thought to look for an even shorter method.
I would also be interested in a webinar.
Best,
Tyler
Ahmadou Dicko via ESS-help writes:
> I do agree with your suggestion. There is much more to ESS than
> I
> know and it would be great if we could pool our resources to
> improve
> further. For my part `ess-describe-object-at-point` really
> improved by
> workflow as it can be customized to include any function.
>
> Indeed, it would be great to pool resources on R package
> development in
> ESS.
> I use a lot the new ess-r-package-mode and the devtools wrapper
> (C-c C-w
> *), it wraps several useful devtools functions for loading,
> documenting,
> testing, checking, etc.
> For roxygen, I use C-c C-o C-o to generate a roxygen template
> for a given
> function and C-c C-w d to document (Rd, NAMESPACE, etc.)
> I would love to know what other people are doing and happy to
> contribute as
> well.
>
> Best,
>
>
> On Thu, Oct 8, 2020 at 12:45 PM Jeremie Juste via ESS-help <
> ess-help using r-project.org> wrote:
>
>> Hello Dirk,
>>
>> On Thursday, 8 Oct 2020 at 06:57, Dirk Eddelbuettel wrote:
>>
>> > We all may be a little different here.
>> >
>> > ESS now wraps around devtools, but my practices predate
>> > devtools. So I
>> still
>> > build, test, install, ... on the command-line for which I use
>> > wrappers
>> (from
>> > my littler package, just updated yesterday) named
>> > build.r
>> > check.r
>> > rcc.r # a nicer checker around rmdcheck
>> > roxy.r # run roxygen, I use a 'cached' 6.1.1 version
>> > that does not
>> force recompile...
>> > install.r # plus various install* variants for BioC, or
>> > GitHub, or
>> binaries...
>> > kitten.r # using a wrapper around package.skeleton()
>> > render.r # run rmarkdown::render()
>> > ...
>> Many thanks for sharing this. It is an option that suites me
>> perfectly.
>>
>> > It may actually make sense for _all of use_ to maybe pool for
>> > two or
>> three
>> > hours and a webinar over Zoom for 'favourite ESS' tricks. I
>> > keep
>> forgetting
>> > how there is -- just yesterday I once again forgot C-c C-e w
>> > and looked
>> for
>> > the cheat sheet pdf and there are a bootload of options I
>> > never used
>> > ...
>> I do agree with your suggestion. There is much more to ESS than
>> I
>> know and it would be great if we could pool our resources to
>> improve
>> further. For my part `ess-describe-object-at-point` really
>> improved by
>> workflow as it can be customized to include any function.
>>
>> Best regards,
>> --
>> Jeremie Juste
>>
>> ______________________________________________
>> ESS-help using r-project.org mailing list
>> https://stat.ethz.ch/mailman/listinfo/ess-help
>>
--
Tyler Smith
plantarum.ca
More information about the ESS-help
mailing list