readme2vignette

0.1.0

Convert README to Vignette During Package Installation

0packages depend

2.1Kdownloads / year

–test coverage

12/13checks pass

Overview

About

Maintained by Mao KobayashiFirst published 2024-06-261 releasesCRAN page ↗GitHub ↗

Convert README.md to vignettes when installing packages without vignettes.

Install

R (CRAN)pak (dev)Ubuntu (r2u)Fedora (COPR)openSUSE (OBS)

install.packages("readme2vignette", repos = "https://cloud.r-project.org/")

Installs the current CRAN release. Prebuilt binaries on Windows and macOS.

if (!requireNamespace("pak", quietly = TRUE))
  install.packages("pak", repos = "https://cloud.r-project.org/")
pak::pak("indenkun/readme2vignette")

Development version from indenkun/readme2vignette. Installs pak first if it is not already available.

Release

# enable cranapt (r2u) if it is not already set up, then install
grep -rqs r2u.stat.illinois.edu /etc/apt/sources.list /etc/apt/sources.list.d/ \
  || curl -fsSL https://raw.githubusercontent.com/eddelbuettel/r2u/master/inst/scripts/add_cranapt_noble.sh | sudo bash
sudo apt install -y r-cran-readme2vignette

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled.

bspm (used by r2u) also needs make: sudo apt install make

# enable the iucar/cran COPR if it is not already present, then install
ls /etc/yum.repos.d/*iucar*cran*.repo >/dev/null 2>&1 \
  || sudo dnf copr enable -y iucar/cran
sudo dnf install -y R-CRAN-readme2vignette

RPMs from the iucar/cran COPR, rebuilt from CRAN.

For install.packages() integration in R, also: sudo dnf install R-CoprManager

# add the autoCRAN OBS repo (Tumbleweed) if it is missing, then install
zypper -q lr | grep -qi autoCRAN \
  || sudo zypper addrepo https://download.opensuse.org/repositories/devel:/languages:/R:/autoCRAN/openSUSE_Tumbleweed/devel:languages:R:autoCRAN.repo
sudo zypper install -y R-readme2vignette

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed).

Health

CRAN checks

1NOTE12OK

Failing flavors

NOTE r-devel-linux-x86_64-debian-gcc

Slowest check: 1.2 min · r-devel-windows-x86_64

Code health

None

Tests · ratio 0.00

not tracked

Coverage

100%

Documentation · exports

Dependencies · direct

Check history

NOTE2026-08-01
12 OK · 1 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
OK2026-03-10
14 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE

Documentation

READMEYes · 323 wordsVignettesNopkgdown siteNoNEWSYes · 67% structuredCode of conductNoContributing guideNo

Examples that run: 0%
Documented parameters: 100%
Return-value docs: 100%
References docs: 0%

Downloads

2.1K

CRAN downloads in the past year

Rank #22,525 · ~6/day · ~179/mo

Releases R versions

Daily download trend is not available in this view yet.

13930 days

47990 days

2.1K1 year

Compare downloads with other packages →

Also on96 r2u2 autocran

Repository

GitHub ↗ indenkun/readme2vignette

0Stars

0Forks

0Open issues

0Open PRs

0Releases

Last activity 2024-06-26

Repository practices

Upstream repositoryBeta

5 development-tooling and community-health practices detected across 4 families in the upstream repository

Checks run against github.com/indenkun/readme2vignette on 2026-07-31.

Continuous integration (1)

GitHub Actions

CRAN release process (2)

cran-comments.mdCRAN-SUBMISSION

Docs source (1)

README.Rmd

Lint, format, editor (1)

RStudio project

How this is detected·Detection ruleset v1 (2026-07-18)

Dependencies

Declared dependencies

9 external dependencies (excludes base and recommended)

Depends (0)

none

Imports (10)

desc fs glue knitr pkgbuild remotes rmarkdown usethisutilswhisker

LinkingTo (0)

none

Suggests (0)

none

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

Code & Tests

People & History

People (1)

Maintainer (1)

Mao Kobayashi

Author, Maintainer

Authors (1)

Mao Kobayashi

Author, Maintainer

Package Timeline

1 release. R releases are shown for context.

R
R 4.6.0 released · 2026-04-24
0.1.0Latest
2026-03-10 · current release
R
R 4.5.0 released · 2025-04-11

Package metadata

First published: 2024-06-26
Total releases: 1 / 2 yrs
License: MIT + file LICENSE OSI
Download size: 7.9 KB
Installed size: not tracked yet
With dependencies: not tracked yet

Report a problem with this page →