jss: Metainformation Processing for JSS Publications

In jss: Journal of Statistical Software Utilities

Metainformation Processing for JSS Publications

Description

Utilities for processing the metainformation of (forthcoming) publications in the Journal of Statistical Software (JSS).

Usage

jss(dir = ".")

## S3 method for class 'jss'
format(x, style = "BibTeX", ...)
## S3 method for class 'jss'
as.character(x, ...)

Arguments

dir	character specifying the directory to a JSS publication along with supplementary files (if any).
x	an object of class jss.
style	character specifying the style of string that should be generated (BibTeX, CITATION, or README).
...	arguments passed to other functions.

Details

The function jss sets up a list with information about the publication and corresponding supplementary files. The resulting object of class jss can then be formatted or coerced into different formats.

Value

jss returns an object of class "jss", i.e., a list with components as follows.

key	character vector with two possible styles of bib keys,
author	character vector with LaTeX-style formatted authors,
person	person vector of authors,
title	character with simple text title,
textitle	character with LaTeX-formatted title (including proglang, pkg, etc.),
plaintitle	character with plain LaTeX-formatted title (without proglang, pkg, etc.),
journal	character with journal/section,
year	year of publication,
month	month of publication,
volume	volume,
number	issue,
pages	number of pages,
url	JSS URL,
doi	DOI,
type	type of publication (article, code snippet, book review, or software review),
directory	character with path to all files,
package	name of package(s) associated with the publication,
rpackage	logical indicating whether the publication is associated with an R package,
readme	character with path to readme.txt file (if any),
rscript	character with path to .R script (if any).

See Also

bibentry, person

jss documentation built on Sept. 9, 2022, 3:09 p.m.