-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathREADME.Rmd
192 lines (134 loc) · 8.98 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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
---
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/README-",
out.width = "100%"
)
```
# namedropR <img src="man/figures/logo.png" align="right" width="150"/>
<!-- badges: start -->
[](https://CRAN.R-project.org/package=namedropR) [](https://github.com/nucleic-acid/namedropR/actions) [](https://CRAN.R-project.org/package=namedropR) [](https://CRAN.R-project.org/package=namedropR)
<!-- badges: end -->
`namedropR` provides 'visual citations' containing the metadata of a scientific paper and a 'QR' code.
## Installation
To install, simply run:
``` r
install.packages("namedropR")
```
You can install the development version of namedropR from [GitHub](https://github.com/) with:
``` r
# install.packages("remotes")
remotes::install_github("nucleic-acid/namedropR")
```
## Visual Citations
A 'visual citation' is a banner containing an article's title, authors, journal and year of a publication (s. example below).
<img src="man/figures/collaboration_2019_ApJL.png" alt="A visual citation pointing to a scientific paper. Scan with a QR code scanner to follow the URL." align="right" width="500" style="box-shadow: 8px 8px 6px grey;"/>
One might want to include this in a presentation
- to back up one's claims,
- to drop an important name,
- to boast about a publication in a 'high impact journal'.
*Some might even use this to genuinely **point the audience to good resources** for further reading.*
On conferences, such banners are frequently displayed way too short for the audience to actually comprehend them (and often in a bad resolution). Creating visual citations requires manually taking a screenshot and placing it on the slide.
<img src="man/figures/hawking_1973.png" alt="A compact visual citation pointing to a scientific paper. Scan with a QR code scanner to follow the URL." align="left" width="130" style="box-shadow: 5px 5px 6px grey;margin-right: 15px"/>
`namedropR` helps to generate visual citations conveniently (see below), in high resolution and with a QR code. This allows the audience to follow the reference *while you are talking about it*, instead of looking it up in a reference list at the end of your talk.
There is also a less intrusive, compact style, as seen on the left.
## Basic Usage
### Working with bibtex bibliographies
This package accepts bibliographic information as 'BibTeX' and 'BibLaTeX' references and includes a QR code pointing to the ['DOI'](https://www.doi.org). If the 'DOI' is not available in the bibliography entry, but a 'URL' field instead, this is used. If neither is given, the QR code points to a search call at <https://scholar.google.com> with the available data as search terms.
``` r
bib_path <- "path/to/bibliography_file.bib"
# load the package
library('namedropR')
drop_name(bib_path, cite_key = "SomeAuthor2010")
```
`drop_name()` by default returns the file path, where the visual citation was stored as character string. Within an Rmarkdown/HTML presentation you can render the VC and directly pass the path to `{htmltools}` to include the banner:
``` r
# PNG
htmltools::img(
src = drop_name(
bib_path,
cite_key = "SomeAuthor2010",
export_as = "png"
)
)
# HTML (note the recommended option use_xaringan, see documentation for details)
htmltools::includeHTML(
drop_name(
bib_path,
cite_key = "SomeAuthor2010",
export_as = "html",
use_xaringan = TRUE
)
)
```
To **bulk-create** VCs to include in another kind of document / presentation slides you can pass a vector of citation keys or pass no keys at all to render some or all bibliography entries respectively:
``` r
drop_name(
bib_path,
cite_key = c("SomeAuthor2010", "SomeOther2011", "YetAnother2012"),
export_as = "png",
style = "clean"
)
#> renders the three specified banners
drop_name(
bib_path,
export_as = "png",
style = "clean"
)
#> renders all entries within the specified bibliography file
```
### Pulling data from Crossref
If you don't have a *.bib file, but DOIs instead, you can pass them to `drop_name_crossref()` which pulls the data from [Crossref](https://www.crossref.org) and passes the downloaded data on to `drop_name()`.
**TEMPORARY NOTE:** *Due to recent API changes in Crossref you need to have {rcrossref} version >= 1.2 installed.*
``` r
# DOIs can be named vectors...
drop_name_crossref(c(cite1 = "10.1126/science.169.3946.635", cite2 = "10.1111/joms.12670"))
# ...or unnamed vectors
drop_name_crossref(c("10.1126/science.169.3946.635", "10.1111/joms.12670"))
```
All options, that can be passed to `drop_name()`, can also be specified in `drop_name_crossref()`, for example the following call pulls data for two references from Crossref and renders them as PNG files with the 'newspaper' style:
``` r
drop_name_crossref(
c(cite1 = "10.1126/science.169.3946.635", cite2 = "10.1111/joms.12670"),
export_as = "png",
style = "newspaper"
)
```
## Options
It is possible to specify output format (HTML or PNG), style, size of the QR code and much more. See the vignettes for all options.
These are some frequently used options:
``` r
# create a visual citation as PNG with 'modern' design
drop_name(bib_path, cite_key = "SomeAuthor2010", export_as = "png", style = "modern")
# create a visual citation as HTML with 'compact' design
drop_name(bib_path, cite_key = "SomeAuthor2010", export_as = "html", style = "compact")
# set a smaller QR code size, default is 250 (pixels)
drop_name(bib_path, cite_key = "SomeAuthor2010", export_as = "png", qr_size = 150)
# set a wider text area for long titles or long author lists, default is 600 (pixels)
drop_name(bib_path, cite_key = "SomeAuthor2010", export_as = "png", vc_width = 800)
```
## Styles
These are the currently predefined styles:
|Name |Example |
|------|------|
|modern| <img src="man/figures/modern.png" alt="A visual citation pointing to a scientific paper. Scan with a QR code scanner to follow the URL." align="right" width="500" style="box-shadow: 4px 4px 3px grey;"/> |
|modern_bw|<img src="man/figures/modern_bw.png" alt="A visual citation pointing to a scientific paper. Scan with a QR code scanner to follow the URL." align="right" width="500" style="box-shadow: 4px 4px 3px grey;"/> |
|classic|<img src="man/figures/classic.png" alt="A visual citation pointing to a scientific paper. Scan with a QR code scanner to follow the URL." align="right" width="500" style="box-shadow: 4px 4px 3px grey;"/> |
|fancy|<img src="man/figures/fancy.png" alt="A visual citation pointing to a scientific paper. Scan with a QR code scanner to follow the URL." align="right" width="500" style="box-shadow: 4px 4px 3px grey;"/> |
|clean|<img src="man/figures/clean.png" alt="A visual citation pointing to a scientific paper. Scan with a QR code scanner to follow the URL." align="right" width="500" style="box-shadow: 4px 4px 3px grey;"/> |
|newspaper|<img src="man/figures/newspaper.png" alt="A visual citation pointing to a scientific paper. Scan with a QR code scanner to follow the URL." align="right" width="500" style="box-shadow: 4px 4px 3px grey;"/> |
|compact| <img src="man/figures/compact.png" alt="A visual citation pointing to a scientific paper. Scan with a QR code scanner to follow the URL." align="left" width="180" style="box-shadow: 4px 4px 3px grey;"/>|
Styling is possible via these predefined designs or via custom 'CSS' e.g. to match the design of the HTML presentation like e.g. 'xaringan' or 'revealJS' (see the vignette for more options).
## How to contribute
If you have ideas for Visual Citation styles and think, everyone should be able to use them, feel free to [open an issue](https://github.com/nucleic-acid/namedropR/issues) and describe the style or provide the CSS code, if you have one already.
If you want to speed things up, you can fork the project to create a pull request. Please also open an issue, so we can have a discussion, if needed. See the [readme](https://github.com/nucleic-acid/namedropR/blob/main/inst/styles/readme.md) for details.
## Code of Conduct
Please note that the namedropR project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
## Notes
- This package is not intended as replacement for proper reference manager packages, but a tool to enrich scientific presentation slides. Hence the functionality is quite limited to this specific use case.
- previous versions (before v2.0) allowed passing `RefManageR::BibEntry()` objects. This option was removed to eliminate dependency on the orphaned `{bibtex}` package. This might break code for users of initial releases of the package, but was needed to allow for CRAN submission.