From alsergbox at gmail.com  Mon Jan 20 10:32:56 2014
From: alsergbox at gmail.com (Alexey Sergushichev)
Date: Mon, 20 Jan 2014 13:32:56 +0400
Subject: [Rd] Using unit-tests as examples
In-Reply-To: <CABdHhvFbSqmyE6zYWvXw5NKJ1NXq4e2aFc8WzPqkiM2d4U445A@mail.gmail.com>
References: <CAMGHQ97ct+FQc361micsLrx8CYnFE8WHvCBtVLvWL82bdpDFhA@mail.gmail.com>
	<CABdHhvFbSqmyE6zYWvXw5NKJ1NXq4e2aFc8WzPqkiM2d4U445A@mail.gmail.com>
Message-ID: <CAMGHQ94yaG=3mvka4E8RvNf9JyL9-yBPFUiy=iHOzXTFFSTC6g@mail.gmail.com>

Yes, this may work, but this way I have to have one test per file,
which is not very convenient.

---
Alexey


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.
>
> Hadley
>
> On Sat, Jan 18, 2014 at 7:18 AM, Alexey Sergushichev
> <alsergbox at gmail.com> wrote:
>> Hi,
>>
>> 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,
>> Alexey
>>
>> ______________________________________________
>> R-devel at r-project.org mailing list
>> https://stat.ethz.ch/mailman/listinfo/r-devel
>
>
>
> --
> http://had.co.nz/



[Rd] Using unit-tests as examples
Alexey Sergushichev