Using Roxygen2 for my utility functions

Question

In my analysis projects (not a package), I usually have utility functions that I source() in different analysis scripts.

I've been using the Roxygen2 documentation convention (e.g. starting the documentation with #', which is well supported in RStudio.

Can I make these documentation available via help(my_utility_function)? Everything I read so far uses Roxygen2 and devtools::document() in the context of a package. Indeed, when I tried to use devtools::document(), it complains about not being able to find the package root.

Roman Luštrik · Accepted Answer · 2017-05-31 20:14:41Z

2

You will need to make it into a package.

answered May 31, 2017 at 20:14

Roman Luštrik

70.9k25 gold badges160 silver badges203 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Heisenberg Over a year ago

Do you have any solution for documenting utility functions? Should I just "go to source" when I want to understand its argument?

Roman Luštrik Over a year ago

@Heisenberg my recommendation would be to... make a package. :) It's also a neat way to distribute your work.

Collectives™ on Stack Overflow

Using Roxygen2 for my utility functions

1 Answer 1

2 Comments

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Related