impact_auth: Provide a citation for a research publication

View source: R/impact_auth.R

impact_authR Documentation

Provide a citation for a research publication

Description

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

Usage

impact_auth(
  data,
  author_list = "author_list",
  pub_group = "pmid",
  max_inital = 1,
  upset = FALSE,
  metric = FALSE
)

Arguments

author_list

A vector of the collapsed authorship lists of each publication, listed per row (should be an output from paste0(x, collapse = ", ")).

pub_group

A vector of the research outputs (the paper or project authored) which the authors are being compared across (default = pmid)

max_inital

= Number of initials to match authors on (default = 1).

upset

Compare intersections of authorship across each pub_group, and produces data format suitable for producing UpSet plots (default = FALSE).

metric

Provide author engagement metrics across each pub_group (default = FALSE)

df

Dataframe with 2 mandatory columns (1) pub_group (the paper or project authored) (2) auth_list = A string of all authors for the pub_group.

Value

Nested dataframe of: (1). "auth_out" - All unique authors; (2). data_upset = intersection data (if upset = TRUE). (3). metric = author engagement metrics (if metric = TRUE).


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