-
Notifications
You must be signed in to change notification settings - Fork 4
/
README.Rmd
80 lines (48 loc) · 3.19 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
devtools::load_all()
```
# `biosketchr` `v`r packageVersion("biosketchr")`` <img src="man/figures/logo.png" align="right" width="30%" height="30%"/>
<!-- badges: start -->
[](https://www.tidyverse.org/lifecycle/#experimental)
[](https://travis-ci.com/TysonStanley/biosketchr)
[](https://github.com/TysonStanley/biosketchr/actions)
<!-- badges: end -->
The goal of `biosketchr` is to make two aspects of creating a Biosketch for either NIH (National Institutes of Health in the United States) or NSF (National Science Foundation in the United States) better:
1. Formatting of the biosketch is automatically done for you
2. The citations are automatically formatted and inserted in the document
## Installation
You can install `biosketchr` with:
``` r
remotes::install_github("tysonstanley/biosketchr")
```
## LaTeX
#### NIH Template
The template was created by Paul M. Magwene and can be found at: [github.com/pmagwene/latex-nihbiosketch](https://github.com/pmagwene/latex-nihbiosketch).
#### NSF Template
The template was created by Theodore P. Pavlic and can be found [here](http://phaseportrait.blogspot.co.uk/2013/02/latex-template-for-nsf-style.html).
## Example
To start, you'll want to select the appropriate template (for this example, the NIH one) from the `biosketchr` package. This will create a folder with whatever name you choose that contains an `Rmd` file, the appropriate `.cls` file, and a `.bib` file.
<img src="man/figures/select_template.png" align="center" width="50%" height="50%"/>
The `.Rmd` file will open automatically showing you this template.
<img src="man/figures/skeleton_rmd.png" align="center" width="50%" height="50%"/>
This is where you'll do all the editing, writing your statement, fill in education, etc. You'll also want to edit the `yourbibfile.bib` file with your citations that you want to include in the biosketch.
When you `knit` this, it will produce a PDF file in the same folder that is formatted like the appropriate biosketch. This PDF will look something like the following:
<img src="man/figures/pdf_output_example.png" align="center" width="50%" height="50%"/>
A very similar process works for the NSF template, with slighty different fields in the skeleton RMarkdown file.
Enjoy biosketching with RMarkdown!
## Note
The package is still undergoing some development and we would love feedback on any aspect that doesn't work as expected.
We also want to thank the [`rticles`](https://github.com/rstudio/rticles) package for showing how to create RMarkdown templates such as in `biosketchr`.
Please note that the 'biosketchr' project is released with a
[Contributor Code of Conduct](CODE_OF_CONDUCT.md).
By contributing to this project, you agree to abide by its terms.