README.md

In NicolasJBM/bibliogR: Manage references

bibliogR

The goal of bibliogR is to facilitate the search, citation, edition, and maintenance of references in the scholR package set. It is not a stand alone package as it has to be used in a shiny dashboard for either education or research purposes.

Installation

You can install the development version of bibliogR from GitHub with:

# install.packages("devtools")
devtools::install_github("NicolasJBM/bibliogR")

There is so far no CRAN version.

References database

The use of this module necessitates that a file called “references.RData” exists in the same folder as the shiny dashboard application using bibliogR. This file should contain a single tibble called “references” with the following variables, all of class “character”:

- bibtype - key - author - title - journal - year - month - volume - number - pages

- publisher - booktitle - editor - institution - school - address - edition - note

- doi - url - abstract - keywords - isbn - issn - jnl - field

This database of references is used to produce the bilatex reference file (.bib) used by Rmarkdown (.Rmd) and quarto (.qmd) documents to produce a bibliography (see the “update” action in the edition subsection of the use section).

Uses

This package includes three distinct shiny modules for edition, search, and management.

Edition of references from the control panel

bibliogR::edit_references_ui(“id”) and bibliogR::edit_references_server(“id”) should be added respectively to the control panel and the server of a shinydashboard. This module is a set of action buttons allowing the user to:

• Edit an existing reference or create a new one;
• Delete a reference;
• Reload the reference file (not automatically done after each change);
• Update the bib file containing all the references cited in the documents managed by the shiny application.

Search of references from the control panel

bibliogR::search_references_ui(“id”) and bibliogR::search_references_server(“id”) should also be added to the control panel of a shinydashboard.

Reference management from the main panel

bibliogR::manage_references_ui(“id”) and bibliogR::manage_references_server(“id”)

NicolasJBM/bibliogR documentation built on April 21, 2024, 12:16 a.m.