reference {chronosphere}R Documentation

Retrieve citation of data object

Description

The function prints or returns the citation string of a chosen object/item.

Usage

reference(
  src,
  bibtex = FALSE,
  ser = NULL,
  ver = NULL,
  print = TRUE,
  prefix = ""
)

Arguments

src

(characater) Object downloaded with fetch or the source identifier string.

bibtex

(logical) Should a bibtex be printed/returned?

ser

(character) In case src is character, the series identifier.

ver

(character) In case src is character, the version identifier.

print

(logical) Should the citations be printed to the console, or returned as a character vector.

prefix

(characater) In case the output is printed on the console. Use this to include a prefix before every entry.

Value

By default the function has no return value. If print=FALSE, the function will return a reference character string.

Examples

# A locally-present object, in package's directory
one <- fetch(src="SOM-zaffos-fragmentation",
  datadir=system.file("extdata", package="chronosphere"))
# its reference
reference(one)

[Package chronosphere version 0.6.1 Index]