forked from FRBCesab/zoteror
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
90 lines (53 loc) · 2.64 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(collapse = TRUE,
comment = "#>",
fig.path = "man/figures/",
out.width = "100%")
```
zoteror <img src="man/figures/package-sticker.png" align="right" style="float:right; height:120px;"/>
=========================================================
<!-- badges: start -->
[](https://github.com/FRBCesab/zoteror/actions/workflows/R-CMD-check.yaml)
[](https://github.com/FRBCesab/zoteror/actions/workflows/pkgdown.yaml)
[](https://choosealicense.com/licenses/gpl-2.0/)
<!-- badges: end -->
## Table of contents
<p align="left">
• <a href="#overview">Overview</a><br>
• <a href="#installation">Installation</a><br>
• <a href="#get-started">Get started</a><br>
• <a href="#citation">Citation</a><br>
• <a href="#contributing">Contributing</a>
</p>
## 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. <https://github.com/FRBCesab/zoteror>
## 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.