readme: Access The Package README in a Browser

View source: R/readme.R

readmeR Documentation

Access The Package README in a Browser

Description

Access The Package README in a Browser. With the package installed, access the README of the installed package from CRAN or GitHub with a browser.

Usage

readme(package)

Arguments

package

The name of the package whose README you want to refer to. String. You can specify only one package, and it must be installed.

Details

We refer to the package's Description to determine whether it was installed from CRAN, GitHub, or otherwise.

If the package was installed from CRAN, it accesses the CRAN package web page with the README; if there is no README, an empty web page is displayed.

If the package was installed from GitHub, the web page of package on the GitHubis accessed.


indenkun/infun documentation built on April 17, 2025, 2:52 p.m.