bibstats: Reporting bibliographic statistics

bibstatsR Documentation

Reporting bibliographic statistics

Description

These functions are useful for calculating salient statistics on the bibliographies used for dissertations or syllabi. They include the following functions/metrics:

Usage

percent_female(bib_file, rmd_file, by = c("author", "publication"))

mean_year(bib_file, rmd_file)

mean_pages(bib_file, rmd_file)

total_pages(bib_file, rmd_file)

Arguments

bib_file

A .bib file for the project. If not given, the functions will search for a .bib file in the folder associated with the file the source editor has open.

rmd_file

A .rmd file If not given, the functions will check to see whether the current file open in the source editor is an .rmd file, and if so use that.

by

A string in c("author", "publication") which determines if the percentage of female authors is computed across all papers or the percentage represents the proportion of papers written by at least one woman.

Details

percent_female()

Displays the percentage of authors in a .bib file that are female. See the {gender} package for more details.

mean_year()

Displays the average year of publication of the items in a given .bib file.

mean_pages()

Displays the average number of pages of the items in a given .bib file.

total_pages()

Displays the total number of pages of all items in a given .bib file.

Value

Prints a summary statistic (e.g. mean or proportion)


iheiddown documentation built on Nov. 10, 2022, 5:52 p.m.