[Rd] Using unit-tests as examples
alsergbox at gmail.com
Mon Jan 20 10:32:56 CET 2014
Yes, this may work, but this way I have to have one test per file,
which is not very convenient.
On Sat, Jan 18, 2014 at 7:43 PM, Hadley Wickham <h.wickham at gmail.com> wrote:
> If you're using roxygen2, you can use @example tag to include an
> external file into the examples.
> On Sat, Jan 18, 2014 at 7:18 AM, Alexey Sergushichev
> <alsergbox at gmail.com> wrote:
>> Which is the best way to use unit tests as examples for documentation?
>> I use testthat, but if there is a good way to do this, for example,
>> only with RUnit, it'd still be good to know.
>> Unit-tests are usually simple and concise, so they are good candidates
>> for example code, but I don't want to copy them into documentation and
>> maintain by hands. I tried to google how people handle this, but
>> didn't find anything.
>> Best regards,
>> R-devel at r-project.org mailing list
More information about the R-devel