refString: Build TreeCo Reference String

View source: R/refString.R

refStringR Documentation

Build TreeCo Reference String

Description

Function to build the standard TreeCo reference string based on reference information (i.e. metadata)

Usage

refString(
  ref.data = NULL,
  col.names = NULL,
  default.ref.type = "article",
  to.upper = FALSE
)

Arguments

ref.data

the data frame with reference database

col.names

a named list conating the name of the columns needed (see details)

default.ref.type

a character containing the default type of reference to be assumed when the reference type is missing. Defaults to 'article'.

to.upper

should the names of the authors be capitalized. Defaults to FALSE

Details

The standard TreeCo format for the references is adapted from the Chicago citation style. Currently, this is the only citation format available. The general format for an article is:

AUTHORS(s). Year. Title. Publication name volume (issue): start page-end page.

The separation between multiple authors is done using semi-colons.

Value

the data frame ref.data with and extra column containing the reference string in the standard TreeCo format.

Author(s)

Renato A. Ferreira de Lima

See Also

refInfo


LimaRAF/TreeCo documentation built on Sept. 25, 2024, 12:41 p.m.