https://github.com/tysonstanley/biosketchr
An R package built on RMarkdown to create biosketches (e.g. for NIH)
https://github.com/tysonstanley/biosketchr
Last synced: 7 months ago
JSON representation
An R package built on RMarkdown to create biosketches (e.g. for NIH)
- Host: GitHub
- URL: https://github.com/tysonstanley/biosketchr
- Owner: TysonStanley
- Created: 2019-11-09T02:56:19.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-02-25T03:15:41.000Z (over 3 years ago)
- Last Synced: 2025-01-24T18:12:01.097Z (9 months ago)
- Language: TeX
- Homepage: https://tysonbarrett.com/biosketchr/
- Size: 3.13 MB
- Stars: 21
- Watchers: 3
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.Rmd
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
---
output: github_document
---
```{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")`` 
[](https://www.tidyverse.org/lifecycle/#experimental)
[](https://travis-ci.com/TysonStanley/biosketchr)
[](https://github.com/TysonStanley/biosketchr/actions)
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.
The `.Rmd` file will open automatically showing you this template.
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:
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.