What makes a good R package vignette?

JavaScript isn't enabled in your browser, so this file can't be opened. Enable and reload.

What makes a good R package vignette?

Sign in to Google to save your progress. Learn more

Length

How many pages should a vignette have?

< 10 pages

< 20 pages

< 50 pages

Trust author's judgment

Number of pages

Clear selection

Language

What kind of reader should the author have in mind?

R expert and subject expert

R novice and subject expert

R novice and subject novice

R expert but subject novice

Other:

Clear selection

Structure

Rate how important the various sections are to you: 1 Not really needed, 2 Nice to have, 3 Required

1

2

3

Introduction

Motivation

Examples

Road map

Support

Case studies

References

Clear selection

Examples

How much should be demonstrated?

Lots of examples

Don't repeat examples of help pages

Only a few key example to focus on

Suggestion of what could be done, without showing all the output in the vignette

Other:

Examples of good vignettes

Please list packages with good vignettes. Use commas to separate them.

What is the secret of a good vignette?

Please add your comments.

What else?

Questions I should have asked but haven't.

About you

Please provide some information about yourself.

Your R expertise

How much do you know already?

Absolute beginner

I know how to use the R help system

I write my own functions

I create my own package

I published on CRAN

Clear selection

How much do you use vignettes?

Not at all

1

2

3

4

5

Whenever available

Clear selection

Have you written technical documentation?

Have you been through the pain?

I have written help pages

I have written vignettes

I have published papers

Submit

Clear form

Never submit passwords through Google Forms.

This content is neither created nor endorsed by Google.