Stack Overflow
Stack Overflow

Questions tagged [vignette]

Vignette is software that offers content management, portal, collaboration, document management, and records management.

Vignette Corporation is a company headquartered in Austin, Texas, that offers a suite of content management, portal, collaboration, document management, and records management software.

Vignette's Platform consists of several suites of products allowing non-technical business users to create, edit and track content through workflows and publish this content through Web or portal sites.

120 questions
23
votes
5 answers

Knitr: R package check error, object 'opts_chunk' not found

I am getting the following error when checking my R package > Error: could not find function "locdata" > Execution halted > when running code in ‘DFSurvey.Rnw’ > ... > > > opts_chunk$set(cache = TRUE, fig.path = "DFSurveyImages/", dev = "pdf") >…
Mark Otto
  • 277
  • 1
  • 2
  • 5
18
votes
1 answer

How to build a pdf vignette in R and RStudio

I am new to writing R packages. I'm trying to learn how to make a vignette for my package. I have created a vignettes folder with a file "getting-started.Rmd" --- title: "WaterML Tutorial" author: "Jiri Kadlec" date: "`r Sys.Date()`" output:…
jirikadlec2
  • 1,256
  • 1
  • 23
  • 36
14
votes
2 answers

JSTL, Beans, and method calls

I'm working on a JSP where I need to call methods on object that come from a Bean. The previous version of the page does not use JSTL and it works properly. My new version has a set up like this:
Zack The Human
  • 8,373
  • 7
  • 39
  • 60
13
votes
1 answer

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…
user2808302
12
votes
2 answers

How do I 'prebuild' a vignette index for an R package?

I'm preparing a package for submission to CRAN. I use R CMD build myPackage then R CMD check myPackage --as-cran and it passes all checks with no notes or warnings. However, each time I try to submit, I get the following error message from one of…
dardisco
  • 5,086
  • 2
  • 39
  • 54
12
votes
1 answer

R devtools: create both html and pdf of vignettes

I have written a tutorial in vignette form for one of my packages. It works fine, but it only creates the html version of the vignette. Is there a way I can create both the html and the pdf version of my vignettes? I have tried to append…
lucacerone
  • 9,859
  • 13
  • 52
  • 80
11
votes
4 answers

Installing package fails when building vignettes ((..)/doc/index.html is missing)

I'm creating an R package with a vignette. However, when I try to install the package by using devtools::install(build_vignettes = TRUE) an error occurs since it cannot find the file index.html in the doc folder. I thought this file would be…
Linda Nab
  • 111
  • 4
11
votes
1 answer

Package has a VignetteBuilder field but no prebuilt vignette index

I am submitting a package to CRAN and I have got the below warning from the reviewers team: Package has a VignetteBuilder field but no prebuilt vignette index. that I have in fact seen also when running devtools::release(). I am using the last R…
gented
  • 1,620
  • 1
  • 16
  • 20
9
votes
2 answers

Error: processing vignette failed with diagnostics: 4 simultaneous processes spawned

I am building a vignette for R package mistral (see github.com/clemlaflemme/mistral) and the devtools::check(cleanup = FALSE) returns a Warning Error: processing vignette 'mistral-vignette.Rmd' failed with diagnostics: 4 simultaneous processes…
ClementWalter
  • 4,814
  • 1
  • 32
  • 54
9
votes
2 answers

R code in package vignette cannot run on CRAN for security reasons. How to manage such vignette?

An R package communicates with a commercial data base using a private user_name and password to establish connection. In the package_vignette.Rmd file there is a chunk of code: ```{r, eval = TRUE} # set user_name and password from user's…
Mikhail Zvagelsky
  • 133
  • 6
8
votes
4 answers

How to make a vignette effect in HTML?

I'm looking for a good solution on how to make a vignette effect for a website. The corners should be darker than the background color of the page like a radial gradient. So far I tried different approaches: 4 DIVs set to position:absolute,…
DiLer
  • 101
  • 1
  • 1
  • 6
8
votes
3 answers

R -- Vignettes that are not made by Sweave possible?

Can I include some PDF in the pkg/doc folder so that the vignette function works, but no corresponding Rnw, Rtex, etc exists? I am thinking of slides or documents containing markdown text weaved with R chunks, which have a different build process…
Karsten W.
  • 17,826
  • 11
  • 69
  • 103
8
votes
2 answers

R: Skip a vignette being run on CRAN R CMD check

I have a number of vignettes in an R package that are slow to run. As I understand it, a CRAN R CMD check will not rebuild the vignette but will run its corresponding code. Since the vignettes are slow to run, I don't think the adhere to the CRAN…
Jack
  • 367
  • 2
  • 10
8
votes
1 answer

Include errors in R markdown package vignette

I'm developing an R package and have a custom function which contains a if(condition) stop("Error message") conditional. I call this function in a package vignette with the intention of generating the error message and including that in the…
user3713498
8
votes
2 answers

Best practices to alert users of package vignettes when `library(packagename)` is loaded?

I'm writing an R package and spend lots of time on the documentation vignettes. I'm wondering if i should add something like .onAttach <- function( libname , pkgname ){ packageStartupMessage("use `browseVignettes('packagename')` to see…
Anthony Damico
  • 5,779
  • 7
  • 46
  • 77
1
2 3 4 5 6 7 8