generateDescInfo: Converts a DESCRIPTION file to a data.frame

View source: R/pkgHTML.R

generateDescInfoR Documentation

Converts a DESCRIPTION file to a data.frame

Description

Converts a DESCRIPTION file to a data.frame

Usage

generateDescInfo(pkg_path, encoding = "")

Arguments

pkg_path

The path preceding the location of the DESCRIPTION file

encoding

If there is an Encoding field, to what encoding should re-encoding be attempted? The other values are as used by iconv, so the default "" indicates the encoding of the current locale

Value

If a DESCRIPTION file for the given package is found and can successfully be read, this function returns a data.frame ontaining of the fields as headers and the tags as rows

Author(s)

Dinakar Kulkarni <kulkard2@gene.com>


gmbecker/gRAN documentation built on July 5, 2023, 11:05 p.m.