R devel - May 2014 - Writing my first CRAN vignette

In fact my first vignette full stop.

I am intending to use Sweave. I have read the Sweave documentation 
and section 1.4 of the extensions manual and apart from (a) do not 
use split = TRUE (b) and include all the source components, there 
does not seem to be anything CRAN specific.

1 - Am I missing some other documentation?
2 - If I use a package from CTAN would that be considered within the 
spirit if not the letter of open source? I am not asking for trained 
legal advice here, it is the spirit of the rules.
3 - I assume including the .bbl file would be fine rather than making 
a separate .bib file?

I am not envisaging doing anything complex: text, formulae, some 
tables and one figure plus a few references.


Michael Dewey
info at aghmed.fsnet.co.uk
http://www.aghmed.fsnet.co.uk/home.html

On 18/05/2014 13:33, Michael Dewey wrote:
> In fact my first vignette full stop.
>
> I am intending to use Sweave. I have read the Sweave documentation and
> section 1.4 of the extensions manual and apart from (a) do not use split
> = TRUE (b) and include all the source components, there does not seem to
> be anything CRAN specific.
>
> 1 - Am I missing some other documentation?
There is no such thing as a 'CRAN vignette'.  These days all 
(non-internal-to-CRAN) CRAN-specific documentation is in the CRAN policies.
> 2 - If I use a package from CTAN would that be considered within the
> spirit if not the letter of open source? I am not asking for trained
> legal advice here, it is the spirit of the rules.
Provided it is available to people to reproduce things if the package 
uses a FOSS licence.
> 3 - I assume including the .bbl file would be fine rather than making a
> separate .bib file?
No.  We have seen .bbl files which no longer worked after a TeXLive 
update, and with a FOSS licence you need to supply the sources (and 
normally the .bib file is the source).
>
> I am not envisaging doing anything complex: text, formulae, some tables
> and one figure plus a few references.
>
>
> Michael Dewey
> info at aghmed.fsnet.co.uk
> http://www.aghmed.fsnet.co.uk/home.html

-- 
Brian D. Ripley,                  ripley at stats.ox.ac.uk
Professor of Applied Statistics,  http://www.stats.ox.ac.uk/~ripley/
University of Oxford,             Tel:  +44 1865 272861 (self)
1 South Parks Road,                     +44 1865 272866 (PA)
Oxford OX1 3TG, UK                Fax:  +44 1865 272595

> I am intending to use Sweave. I have read the Sweave documentation and
> section 1.4 of the extensions manual and apart from (a) do not use split
> TRUE (b) and include all the source components, there does not seem to be
> anything CRAN specific.
I'd strongly recommend using knitr instead - the biggest advantage is
that you can use markdown, which is substantially easier to use than
latex (and doesn't require such a massive toolchain)

Hadley


-- 
http://had.co.nz/