ref_publication: Provide a citation for a research publication

View source: R/ref_publication.R

ref_publicationR Documentation

Provide a citation for a research publication

Description

Used to generate a text version of the difference between 2 dates.

Usage

ref_publication(
  df,
  author = "author",
  title = "title",
  journal = "journal",
  year = "year",
  volume = "volume",
  issue = "issue",
  pages = "pages",
  pmid = "pmid",
  doi = "doi",
  max_auth = FALSE,
 
    ref_format = "author. title. journal. year; volume (issue): pages. PMID: pmid. DOI: doi."
)

Arguments

df

Dataframe with publications listed rowwise

author

String of column name with publication authors listed (mandatory).

title

String of column name with publication title listed (mandatory).

journal

String of column name with publication journal name listed (mandatory).

year

String of column name with publication year listed (mandatory).

volume

String of column name with publication volume listed (mandatory).

issue

String of column name with publication issue listed (optional)

pages

String of column name with publication pages listed (mandatory).

pmid

String of column name with publication pmid listed (optional)

doi

String of column name with publication journal name listed (optional).

max_auth

Argument to limit number of authors listed to the number specified. All n+1 authors will be replaced by a single "et al.". (default = FALSE e.g. no restriction).

ref_format

Customisable string specifying the exact format for the preferred referencing style (default is Vancouver style). Note exact parameter names are required and are limited to those specified.

Value

Dataframe with addition of citation variable.


kamclean/impactr documentation built on Jan. 11, 2023, 2:51 p.m.