revise

R package for writing revise and resubmits

https://github.com/conig/revise

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
○
.zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (13.9%) to scientific vocabulary

Last synced: 10 months ago · JSON representation

Repository

R package for writing revise and resubmits

Basic Info

Host: GitHub
Owner: conig
License: other
Language: R
Default Branch: main
Size: 5.29 MB

Statistics

Stars: 3
Watchers: 5
Forks: 2
Open Issues: 2
Releases: 0

Created about 5 years ago · Last pushed about 1 year ago

Metadata Files

Readme License

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  out.width = "100%"
)
```

# revise


[![R-CMD-check](https://github.com/conig/revise/workflows/R-CMD-check/badge.svg)](https://github.com/conig/revise/actions)


The goal of revise is to support authors in responding to revise and resubmit requests. These functions are designed to work with [crsh/papaja](https://github.com/crsh/papaja).

## Installation

You can install the development version of {revise} from [GitHub](https://github.com/conig/revise) with:

``` r
# install.packages("remotes")
remotes::install_github("conig/revise")
```
# Starting a revision document

## ReviewerComment addin

We have included an addin so you can mark text as a reviewer comment. If a YAML header is not detected in document the addin will add it. Fields will automatically be filled in if there is a .rmd file in the working directory. Additionally, selected text will be marked as a reviewer comment by including it within an "asis" chunk. Text below this chunk will be tagged as an author response. A hotkey can be set for this addin (e.g. Ctrl+Shift+R).

![animation of ReviewerComment addin](man/figures/README/ReviewerComment.gif)

# Loading a manuscript

You can use rmd or docx files with revise. To load either, simply call revise::read_manuscript("your_file.rmd")

For example. Here is an example docx where content has been tagged with comment boxes. E.g, Revise::hard
```{r}
docx_path <- system.file("examples/word_test.docx", package = "revise")

man <- read_manuscript(docx_path)
man
```

We can see all tagged sections by running

```{r}
names(man$sections)
```

Then we can retrieve using a section name

```{r}
revision <- get_revision("hard", man)
revision
```

This content can then be put directly into a response document using single backticks.

Owner

Name: James Conigrave
Login: conig
Kind: user
Location: Sydney
Company: The University of Sydney

Website: conigrave.com
Twitter: jamesconigrave
Repositories: 6
Profile: https://github.com/conig

Research Fellow at the University of Sydney

GitHub Events

Total

Issues event: 8
Delete event: 4
Issue comment event: 17
Push event: 33
Pull request review event: 1
Pull request event: 10
Create event: 3

Last Year

Issues event: 8
Delete event: 4
Issue comment event: 17
Push event: 33
Pull request review event: 1
Pull request event: 10
Create event: 3

Issues and Pull Requests

Last synced: 10 months ago

All Time

Total issues: 4
Total pull requests: 4
Average time to close issues: 6 months
Average time to close pull requests: 4 days
Total issue authors: 2
Total pull request authors: 2
Average comments per issue: 1.0
Average comments per pull request: 0.25
Merged pull requests: 4
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 3
Pull requests: 4
Average time to close issues: 12 days
Average time to close pull requests: 4 days
Issue authors: 2
Pull request authors: 2
Average comments per issue: 1.33
Average comments per pull request: 0.25
Merged pull requests: 4
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

conig (5)
cjvanlissa (2)

Pull Request Authors

conig (5)
cjvanlissa (1)

Top Labels

Issue Labels

enhancement (1)

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- cran 440 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 1
Total maintainers: 1

cran.r-project.org: revise

Dynamic Revision Letters for 'Rmarkdown' Manuscripts

Homepage: https://github.com/conig/revise
Documentation: http://cran.r-project.org/web/packages/revise/revise.pdf
License: MIT + file LICENCE
Latest release: 0.1.0
published over 1 year ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 440 Last month

Rankings

Dependent packages count: 27.1%

Dependent repos count: 33.4%

Average: 49.1%

Downloads: 87.0%

Maintainers (1)

james.conigrave@gmail.com