Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andreas-bauer/rejoinderoo
Rejoinderoo creates a rejoinder (response to reviewers) LaTeX document based on a CSV file.
https://github.com/andreas-bauer/rejoinderoo
academic csv latex rejoinder
Last synced: about 2 months ago
JSON representation
Rejoinderoo creates a rejoinder (response to reviewers) LaTeX document based on a CSV file.
- Host: GitHub
- URL: https://github.com/andreas-bauer/rejoinderoo
- Owner: andreas-bauer
- License: mit
- Created: 2023-02-28T20:39:57.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T11:36:01.000Z (7 months ago)
- Last Synced: 2024-05-22T12:44:14.688Z (7 months ago)
- Topics: academic, csv, latex, rejoinder
- Language: Python
- Homepage:
- Size: 394 KB
- Stars: 16
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rejoinderoo
Rejoinderoo creates a rejoinder (response to reviewers) LaTeX document based on a CSV file.
An example of a generated rejoinder document is shown in [example.pdf](./example.pdf).
## Prerequisites
First, ensure that you have a [working Python 3 environment installed](https://docs.python.org/3/using/index.html).
Rejoinderoo depends on [Pick](https://pypi.org/project/pick/) to provide the selection interface for
data fields of the CSV file.
Install the dependencies using the `requirements.txt` file.
```sh
pip3 install -r requirements.txt
```
## Usage
Step 1) Prepare the response to reviewers in a spreadsheet and export it as a CSV file,
like the [input.csv](./input.csv).
At least three columns are required to be able to parse the CSV file.
Have a look at as an example of
Step 2) Run `main.py` with two arguments: the input CSV file and the output file name.
```sh
# show help
python3 main.py -h
# usage
python3 main.py input.csv output.tex
```
Step 3)
Select all fields (columns) from the CSV file
that shall be included in the generated document.
```sh
$ python3 main.py
Select at least three fields (ID, reviewer comment, author response)
(x) ID
(x) Comment
* (x) Response
( ) Action
( ) Where
( ) Status
( ) Responsible
```
### Color coding of responses
The response boxes are color-coded based on the ID field,
which is the first selected field.
To determine different reviewers, the prefix of the ID field value is used until the first delimiter (`.`, `-`, or `:`).
E.g., `Rev1.3` becomes `Rev1` and `R1:3` becomes `R1`.
In the next step, a custom LaTeX color is created for each reviewer that can be adjusted.
`\colorlet{colorRev1}{blue!15!white}`
## Customization
To customize the generated LaTeX file, you can either adjust [template.tex](./template.tex) or replace it with your own file.
The script will replace the placeholder `%%%%%custom-command%%%%%` and `%%%%%ccomments%%%%%` in the [template.tex](./template.tex) file with the generated content.
## License
Copyright © 2023-2024 Andreas Bauer
This work (source code) is licensed under [MIT](./LICENSE).