https://github.com/kguidonimartins/minimalTemplate
A R package to create a minimal template for scientific manuscripts in .docx
https://github.com/kguidonimartins/minimalTemplate
Last synced: 4 months ago
JSON representation
A R package to create a minimal template for scientific manuscripts in .docx
- Host: GitHub
- URL: https://github.com/kguidonimartins/minimalTemplate
- Owner: kguidonimartins
- License: other
- Created: 2018-06-01T20:54:40.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2022-01-15T21:13:20.000Z (about 3 years ago)
- Last Synced: 2024-08-13T07:14:11.205Z (8 months ago)
- Language: R
- Homepage: https://kguidonimartins.github.io/minimalTemplate/
- Size: 367 KB
- Stars: 12
- Watchers: 4
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - kguidonimartins/minimalTemplate - A R package to create a minimal template for scientific manuscripts in .docx (R)
README
---
output: github_document
---
# minimalTemplate
[](https://travis-ci.com/kguidonimartins/minimalTemplate)
[](https://www.repostatus.org/#wip)
[](https://opensource.org/licenses/MIT)
`{minimalTemplate}` is a highly opinionated package to facilitate the production of docx files using [RMarkdown](https://rmarkdown.rstudio.com/). For now, this package has no commitment to the structure standards of the projects or R packages. *Use at your own risk*.
## Installation
You can install the development version of `{minimalTemplate}` with:
``` r
if(!require("remotes")) install.packages("remotes")
remotes::install_github("kguidonimartins/minimalTemplate")
```
## Example
To use the full workflow of the `{minimalTemplate}`, follow the steps below:
1. Set up a new template
2. Download a new citation style
3. Set up the version control of `.docx` files (optional, but recommended)
### 1. Setting up a new template
Set a new template using:
```{r}
# load minimalTemplate
library(minimalTemplate)
# create a temporary directory (for a demo proposal only)
tmp_proj <- file.path(tempdir(), "awesome-manuscript")
# run `setup_template()`
setup_template(tmp_proj)
```
The folder structure of the `awesome-project` project is (*this is not a mandatory structure*):
```{r, eval=TRUE, echo=FALSE, message=FALSE}
if (!require("fs")) install.packages("fs")
fs::dir_tree(path = tmp_proj, recurse = TRUE, all = TRUE)
```
Open the `main-script.Rmd` file and press the `Knit` button.
### 2. Download a new citation style
Set a new citation style using:
```r
# First, search by your citation style using:
(eco <- grep(pattern = "ecology", x = rcrossref::get_styles(), value = TRUE))
# then:
download_csl(journal_style = eco[4], directory = "manuscript/sources/")
```
### 3. Setting up the version control of `.docx` files
In this step, I'm assuming you want to control the changes (files changes [text and code], entry of new analysis files) in your new project folder. Please, refer to [this](https://kbroman.org/github_tutorial/) to learn how to configure git in your new project template.
To versioning your `.docx` files, just run the function:
```r
setup_wdiff()
```
This function is based on two git hooks (available [here](https://github.com/vigente/gerardus/tree/master/shell-script)) to create a `.md` copy of `.docx` files and track the changes.