search for: vignette

Dear all, I am struggling with an issue related to static vignettes: they work, but only when present in double in the tarball -- in the folder inst/doc and vignettes; see below for details. Details: I am pre-compiling heavy vignettes thanks to the vignette builder R.rsp. So basically, I have PDF files which I want the package to use as Vignettes. For this, I h...

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 by either placing them in the inst/doc hier...

Hello, The vignette concept, which started in Bioconductor, seems to be catching on. They are supported by R CMD build/check and documented in the Writing R Extensions manual. I think vignettes are a fantastic way to introduce new users to a package. However, getting new users to realize that a vignette is availabl...

If I understand correctly, all vignettes in a package are built in the same R process. Global options, loaded packages, etc., in an earlier vignette persist in later vignettes. This can introduce user confusion (e.g., when a later vignette builds successfully because a package is require()'ed in an earlier vignette, but not the c...

Full_Name: Chris Evans Version: 2.3.1 OS: Windoze XP Submission from: (NULL) (217.34.100.197) If I give "vignette("introduction")" I get: Error in sprintf(gettext(fmt, domain = domain), ...) : use format %s for character objects vignette() works for some other vignettes and "vignette()" gets me a list of vignettes and shows three with the name "introduction" (on...

A few things to clarify: 1. You do not necessarily have to keep the \usepackage{} line if you use %\VignetteEncoding{UTF-8}, because Pandoc will use UTF-8 anyway in its LaTeX template. 2. Perhaps the vignette engine in R has done something clever to convert utf8 to UTF-8, but I'd recommend %\VignetteEncoding{UTF-8} instead of %\VignetteEncoding{utf8} to make sure it is a valid encoding name, e.g. &g...

...ge... I do have /doc in my .Rbuildignore for reasons I can no longer remember... I will dig and create a MRE/reprex. The students will download heavy packages, but they probably won't notice. *Apologies* In the meantime, perhaps my question was clear enough to get clarity on: 1) whether having vignettes twice in foders inst/doc and vignettes is normal or not when vignettes are static. 2) where could anyone find a complete documentation on R vignettes since it is a recurring issue in this list and elsewhere. Many thanks On Sun, 1 Nov 2020 at 18:19, Duncan Murdoch <murdoch.duncan at gmail.com&...

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 installat...

I think the online order of vignette files are not based on vignette title or filename alphabetically. I am just curious: by what order these vignette files were displayed online so I can make changes accordingly? Thanks, Zhu -----Original Message----- From: Duncan Murdoch [mailto:murdoch.duncan at gmail.com] Sent: Friday, March 04...

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...

Dear list, we have a markdown vignette for our package in vignette/vignette.md This is not visible from within R with the vignette(package = "mypackage") command. I assume the reason is that the vignette function only shows PDF vignettes. Is there any way to circumvent this and display markdown vignettes directly from within...

As a user, I am always annoyed beyond measure that Sweave vignettes precede the code by a command line prompt. It makes running examples by simple copying of the commands from the vignette to the console a pain. I know the idea is that it is clear what is the command, and what is the output, but I'd rather precede the output with some kind of marking. Is ther...

G'day all, In Chapter 1.4 (Writing package vignettes) the Writing R Extensions manual states: By default @code{R CMD build} will run @code{Sweave} on all Sweave vignette source files in @file{vignettes}. If @file{Makefile} is found in the vignette source directory, then @code{R CMD build} will try to run @command{make} after the @code{Sweave}...

Dear Duncan, The UTF-8 characters aren't properly rendered in the pdf version of the vignette. $?? ????? ?????? ?????? ????? ?? ?? is rendered as $????? ?????????? ???????????? ????? ?????? ? ???????? ???????? The same problem occurs when I use render("vignette.md", output_format = "mypackage::mystyle"), instead of render("vignette.md", output_format = "m...

On 01/11/2020 2:57 p.m., Dirk Eddelbuettel wrote: > > The closest to a canonical reference for a static vignette is the basic blog > post by Mark at > > https://www.markvanderloo.eu/yaRb/2019/01/11/add-a-static-pdf-vignette-to-an-r-package/ > > which I follow in a number of packages. > > Back to the original point by Alexandre: No, I do _not_ think we can do > without a double cop...

Is there a way to include the compiled version of a vignette in the doc directory but mark it to NOT be rerun by CRAN??? I think I remember that this is possible, but have forgotton how.?? (It might even be a false memory.) Terry T. Background:? Beth Atkinson and I are splitting out many of the vignettes from the survival package into a separate package...

...doubt if anyone is going to be able to help you without access to a simple reproducible example of a package that does what you do. Try to cut out as much as you can to make it minimal. For example, devtools::document() (indeed, most of your code) is probably irrelevant to your problem with vignettes, but things like your .Rbuildignore file are not. Duncan Murdoch On 01/11/2020 11:22 a.m., Alexandre Courtiol wrote: > Dear all, > > I am struggling with an issue related to static vignettes: they work, but > only when present in double in the tarball -- in the folder inst/doc and...

I?m preparing a package (fastR) for submission to CRAN, but the vignette index keeps going AWOL, or at least R CMD check ?as-cran thinks so. I?ve tried several things and gave myself the weekend to think of other things, but I can?t figure it out. Perhaps someone on the list can lend a hand. Here?s one example situation, where I build the index.html file myself and pu...

...mind myself of the publicly available packages relevant to my work. As the reference manuals are all online, I am able to flip through the available functions to get an idea of the package's scope before downloading. That said, many authors have taken the time to additionally provide a useful vignette which provides a better overview to complicated packages. However, as far as I can tell, the only way to read or even know if a package has a vignette is to first download and unpack the package source, which is inconvenient when one wants to understand a package _before_ installing. Perhaps an ea...

Greetings. The group that I work with has just started using the approach outlined in Karl Broman's handy primer: http://kbroman.org/pkg_primer/pages/vignettes.html to create vignettes for a couple of R packages. This works fine as long as we have a current Rmd version of the vignette. But we have some old PDF documents that we'd like to include as vignettes as well. I'd like to know if there's a way to include such PDF files as vignettes....