similar to: Links to non-vignette documentation

Displaying 20 results from an estimated 50000 matches similar to: "Links to non-vignette documentation"

2015 Oct 31
1
Example input data with example output using relative pathway in vignette of R package?
I'm putting together an R package. I would like to show example code in the vignette, where example data files (included in the package) are used to generate an (example) output file. I read about using example data in Hadley Wickham's post ( http://r-pkgs.had.co.nz/data.html), and believe I should keep my example data as raw data, as it must be parsed to generate the output. So, I
2013 Sep 17
2
processing of /vignettes and /inst/doc
It is stated in R-exts that Sweave files (.Rnw) are either processed in /vignettes or /inst/doc, not both. Furthermore, it is stated that external manuals and other files in /inst/doc will be installed. This behaviour has been used to deal with the situation where a package has two "vignettes", one that is easily processed and one that has a long running time. This could be done by
2011 Sep 21
1
R CMD build and vignettes
Dear R-helpers, www.statistik.lmu.de/~*leisch*/*Sweave*/*Sweave*-Rnews-2003-2.pdf says that R CMD build creates the pdf from a .Rnw file. But when I do R CMD build followed by R CMD check it gives me a warning that there is a vignette without a PDF. My query is : when R CMD build works it creates a pdf in the doc subdirectory of the directory returned by system.file(package = mypackage) and not
2012 Jun 01
1
Requests for vignette clarification (re: Writing R Extensions)
I apologize that these questions are stupid and literal. I write to ask for clarification of comments in the R extensions manual about vignettes. I'm not great at LaTeX, but I'm not a complete novice either, and some of the comments are puzzling to me. 1. I'm stumbling over this line: "Make sure all files needed to run the R code in the vignette (data sets, ...) are accessible
2014 Feb 20
1
Where to put package vignettes
Dear R-devel list, My name is Guillermo Vinu?. I have created an R package that includes a vignette. Earlier on, to test my package, I tried to install it both in Linux and Windows and it worked. My vignette was in /inst/doc. Now, I have finished for good and before submitting my package to CRAN I've tried to install it again first in Linux and then in Windows (I removed that first
2011 Nov 07
3
CRAN: How to list a non-Sweave doc under "Vignettes:" on package page?
Hi, is it possible to have non-Sweave vignettes(*) in inst/doc/ be listed under 'Downloads' on CRAN package pages? For instance, in my R.rsp package I have a inst/doc/report.pdf (part of the source *.tar.gz) that is not detected/listed. The PDF is not based on a Sweave vignette but an *.tex.rsp vignette that is dynamically created via inst/doc/Makefile. It is listed (*) BTW, can the
2013 Oct 13
1
Compatibility with R 2.15.x: Makefile for (non-Sweave) vignettes in vignettes/?
In R 3.1.0 (~April 2014), support for vignettes in inst/doc/ will go away (and probably much sooner for CRAN submission), e.g. checking for old-style vignette sources ... NOTE Vignette sources only in ?inst/doc?: ?R.devices-overview.tex.rsp? A ?vignettes? directory is required as from R 3.1.0 and these will not be indexed nor checked I've been sticking with inst/doc/ for backward compatible
2014 Feb 20
2
Lugar viñeta paquete
Hola, He terminado de escribir la viñeta de un paquete de R que he desarrollado y terminado, el cual quiero subir al CRAN pero me he encontrado un problema que anteriormente no me ocurría. Hasta ahora, la viñeta la colocaba en el directorio /inst/doc. Es lo que he hecho para instalarme el paquete en mi ordenador, en Fedora 18 con R 2.15.2 y todo se me ha instalado correctamente y a la viñeta
2008 Jul 16
1
Checking package vignettes: WARNING
Hi, I want to have a "vignette" in one of my R packages. Hence, I added an Sweave file into the /inst/doc subdirectory of this package. Unfortunately, 'R CMD check' gives a warning: ========================================== [...] * checking tests ... OK * checking package vignettes in 'inst/doc' ... WARNING --- f?hre texi2dvi auf Vignetten aus * creating
2007 Sep 22
1
R Extensions: Hyperlinking a pdf (not generated by Sweave/not a vignette) from a .Rd file
When constructing an R extension, how can a hyperlink from an .Rd file to a pdf (not generated by Sweave, so not a vignette) located in the inst/doc folder be constructed? Bill Morphet ATK, Space Launch Systems Postflight Evaluation Eng [[alternative HTML version deleted]]
2014 Mar 14
1
Problems building package vignette: Sweave requires multiple passes to build document.
Dear R-devel, Question: How can I get Sweave to recognize that the \thebibliography section is already created and generate the vignette pdf with a single pass? Or is there a way to let R CMD build know that Sweave needs to be run twice? If (1) is not possible, any suggestions how to auto-generate a crude generic bibtex .bib file from my existing document? Background: I maintain
2011 Mar 23
2
system.file() to read a text file from a vignette
[Env: R 2.12.2, WinXp] In a vignette for the vcdExtra package, I had a text file, tv.dat under data/, that I used in the vignette as <<tv1,results=verbatim>>= tv.data<-read.table(system.file("data","tv.dat",package="vcdExtra")) head(tv.data,5) @ I was told that this now generates a warning for non-Rdata files in R CMD check. But I'm now
2011 Mar 30
1
R CMD build processes inst/doc/Makefile only if there are vignette files?
Hi, in Section 'Writing package vignettes' of 'Writing R Extensions' it says: "Whenever a Makefile is found, then R CMD build will try to run make after the Sweave runs, so PDF manuals can be created from arbitrary source formats (plain LaTeX files, ...). [...] Note that the make step is executed even if there are no files in Sweave format, [...]". In my package,
2015 May 14
2
Creating a vignette which depends on a non-distributable file
Dear all, I am writing a vignette that requires a file which I am not allowed to distribute, but which the user can easily download manually. Moreover, it is not possible to download this file automatically from R: downloading requires a (free) registration that seems to work only through a browser. (I'm talking here about the MSigDB from the Broad Institute,
2012 Jun 06
1
stumped on re-building package vignette
[Env: Win Xp / StatET 2.0 / R 2.15.0] In my heplots package I extended the HE-examples.Rnw vignette under inst/doc. The package passes R CMD check on my machine: * using log directory 'C:/eclipse-3.7/heplots.Rcheck' * using R version 2.15.0 (2012-03-30) * using platform: i386-pc-mingw32 (32-bit) ... * checking sizes of PDF files under 'inst/doc' ... OK * checking installed files
2014 Feb 28
3
Lugar viñeta paquete
Hola, Muchas gracias por la respuesta. Sí, hace un par de días pude averiguar dónde se debe colocar la viñeta. Lo resumo a continuación por si a alguien le puede servir: 1) Los archivos de la viñeta (los .Rnw) se ponen en la subcarpeta /vignettes. Ahora, suponiendo que nuestro paquete se llama paq, hay que hacer R CMD check paq R CMD build paq R CMD INSTALL paq_xxx.tar.gz (donde xxx es la
2008 Jan 21
1
Adding an Sweave Vignette to a package
I'm finalizing development of a package that will include a vignette. Without the vignette, the package builds fine with no warnings and is ready for distribution. Now, I am following the directions for developing vignettes "Sweave, Part II: Package Vignettes" by Friedrich Leisch. I am using a windows XP machine (other session info below). Here is what I have done. 1) I add the
2009 Sep 04
1
Viewing pdfs from inst/doc
Writing R extensions says: In addition to the help files in Rd format, R packages allow the inclusion of documents in arbitrary other formats. The standard location for these is subdirectory inst/doc of a source package, the contents will be copied to subdirectory doc when the package is installed. Pointers from package help indices to the installed documents are automatically created.
2006 Jul 31
3
Great R documentation
Dear all, I'm trying to improve the documentation I provide my R packages, and to that end I'd like to find out what you think is great R documentation. I'm particularly interested in function documentation, but great vignettes, websites or book are also of interest. What is your favourite bit of R documentation, and why? Thanks, Hadley
2012 Apr 11
2
Vignette questions
Context: R2.15-0 on Ubuntu. 1. I get a WARNING from CMD check for "Package vignette(s) without corresponding PDF: In this case the vignettes directory had both the pdf and Rnw; do I need to move the pdf to inst/doc? I'm reluctant to add the pdf to the svn source on Rforge, per the usual rule that a code management system should not have both a primary source and a object