An open API service indexing awesome lists of open source software.

https://github.com/frbcesab/zoteror

:package: Retrieve references from Zotero database
https://github.com/frbcesab/zoteror

database r-package references zotero

Last synced: 9 months ago
JSON representation

:package: Retrieve references from Zotero database

Awesome Lists containing this project

README

          

---
output: github_document
---

```{r, include = FALSE}
knitr::opts_chunk$set(collapse = TRUE,
comment = "#>",
fig.path = "man/figures/",
out.width = "100%")
```

zoteror
=========================================================

[![R CMD Check](https://github.com/FRBCesab/zoteror/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/FRBCesab/zoteror/actions/workflows/R-CMD-check.yaml)
[![Website](https://github.com/FRBCesab/zoteror/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/FRBCesab/zoteror/actions/workflows/pkgdown.yaml)
[![License: GPL (>= 2)](https://img.shields.io/badge/License-GPL%20%28%3E%3D%202%29-blue.svg)](https://choosealicense.com/licenses/gpl-2.0/)

## Table of contents


Overview

Installation

Get started

Citation

Contributing

## Overview

The goal of the R package `zoteror` is to connect to the Zotero SQLite database (local only) and to extract bibliographic references metadata as a `data.frame`.

User can:

- select which fields are returned
- filter by type of documents (article, book, book chapter, etc.)

## Installation

You can install the development version from [GitHub](https://github.com/) with:

```{r eval = FALSE}
# install.packages("remotes")
remotes::install_github("FRBCesab/zoteror")
```

Then you can attach the package `zoteror`:

```{r eval = FALSE}
library("zoteror")
```

## Get started

The package `zoteror` only contains the function [`get_zotero_data()`](https://frbcesab.github.io/zoteror/reference/get_zotero_data.html)
to retrieve references metadata from the Zotero local database.

## Citation

Please cite this package as:

> Casajus Nicolas (`r format(Sys.Date(), "%Y")`) zoteror: An R package to
handle Zotero local database. R package version 0.0.1.

## Contributing

All types of contributions are encouraged and valued. For more information,
check out our [Contributor Guidelines](https://github.com/FRBCesab/zoteror/blob/main/CONTRIBUTING.md).

Please note that the `zoteror` project is released with a
[Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html).
By contributing to this project, you agree to abide by its terms.