format_pkg_citation: Produces package citation string

View source: R/format.R

format_pkg_citationR Documentation

Produces package citation string

Description

Formats package as 'pkg' and, when called the first time, adds reference as [@R-pkg]

Usage

format_pkg_citation(
  pkg,
  github_address = NULL,
  force_ref = FALSE,
  make_index = TRUE
)

Arguments

pkg

a pkg availabe locally or github

github_address

github address of package code (eg. "msperlin/vdr")

force_ref

Logical (TRUE or FALSE) - defines whether to force formal reference (e.g. [@R-pkg])

make_index

Logical (TRUE or FALSE) - defines wheter to write index for remissive index of book

Value

a string in rmarkdown

Examples

format_pkg_citation("dplyr")

msperlin/vdr documentation built on Nov. 25, 2022, 2:29 a.m.