getVignetteHeader: A function to read vignette header information
In Bioconductor/DynDoc: Dynamic document tools
getVignetteHeader R Documentation
A function to read vignette header information
Description
Given a vignette filename, will read in the vignette header metadata.
Usage
getVignetteHeader(vig, field)
hasVigHeaderField(vig, field="VignetteIndexEntry")
Arguments
vig
Vignette filename
field
A specific field to extract
Details
The getVignetteHeader function will extract the metadata from a
vignette file and return it as a named list, where the names of the
list elements correspond to the metadata fields, and the elements
themselves the values. If a specific field is desired, it can be
specified with the 'field' argument.
The hasVigHeaderField function is a simple wrapper around
getVignetteHeader and will most likely be removed in the very
near future. It just is a boolean to report if a given header field
exists or not.
Author(s)
Jeff Gentry
Bioconductor/DynDoc documentation built on Nov. 2, 2024, 6:34 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| getVignetteHeader | R Documentation |
A function to read vignette header information
Description
Given a vignette filename, will read in the vignette header metadata.
Usage
getVignetteHeader(vig, field)
hasVigHeaderField(vig, field="VignetteIndexEntry")
Arguments
vig |
Vignette filename |
field |
A specific field to extract |
Details
The getVignetteHeader function will extract the metadata from a
vignette file and return it as a named list, where the names of the
list elements correspond to the metadata fields, and the elements
themselves the values. If a specific field is desired, it can be
specified with the 'field' argument.
The hasVigHeaderField function is a simple wrapper around
getVignetteHeader and will most likely be removed in the very
near future. It just is a boolean to report if a given header field
exists or not.
Author(s)
Jeff Gentry
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.