You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ Prior to beginning this guide, you should also review the script shown in the ac
30
30
-[Citation](#citation)
31
31
-[License](#license)
32
32
33
-
## Features {#features}
33
+
## Features
34
34
35
35
-**TIER Protocol 4.0 Structure:** Organized folder structure (`Data/`, `Scripts/`, `Output/`) aligned with the [TIER Protocol](https://www.projecttier.org/tier-protocol/protocol-4-0/) for clear reproducibility.
36
36
-**Quarto Book Project:** Utilizes [Quarto's powerful book format](https://quarto.org/docs/books/) for creating rich, dynamic documents integrating text, code (R), and outputs.
@@ -42,7 +42,7 @@ Prior to beginning this guide, you should also review the script shown in the ac
42
42
-**Easy Deployment:** Configured for publication on GitHub Pages (gh-page branch) via GitHub Actions (`.github/workflows/deploy.yml`).
43
43
-**Sharing Platform:** Designed for sharing on the [Open Science Framework (OSF)](https://osf.io/).
44
44
45
-
## Prerequisites {#prerequisites}
45
+
## Prerequisites
46
46
47
47
Before using this template for **Full Reproducibility**, ensure you have the following installed on your machine:
48
48
@@ -80,7 +80,7 @@ This method uses the pre-configured Docker setup for the easiest and most reprod
80
80
-**Windows:** Double-click `stop.bat`.
81
81
-**macOS/Linux:** Run `./stop.sh`.
82
82
83
-
## Setup, Build, and Run (Detailed Docker Steps) {#setup-build-and-run-detailed-docker-steps}
83
+
## Setup, Build, and Run (Detailed Docker Steps)
84
84
85
85
If you prefer manual control or want to understand the process:
86
86
@@ -93,14 +93,14 @@ If you prefer manual control or want to understand the process:
93
93
4.**Stop the Container:**
94
94
- To stop and remove the container: `docker-compose down`
95
95
96
-
## Accessing the RStudio Environment {#accessing-the-rstudio-environment}
96
+
## Accessing the RStudio Environment
97
97
98
98
-**URL:**`http://127.0.0.x:8787` (The `start` scripts automatically open this).
99
99
-**Authentication:** No login required (`DISABLE_AUTH=true`).
100
100
-**User:** You are logged in as the `rstudio` user.
101
101
-**Project Location (in Container):**`/home/rstudio/project` (This is your local project folder mounted inside the container).
102
102
103
-
## Daily Workflow {#daily-workflow}
103
+
## Daily Workflow
104
104
105
105
1.**Start:** Use `docker/start.bat` or `docker/start.sh`.
106
106
2.**Work in RStudio:**
@@ -112,19 +112,19 @@ If you prefer manual control or want to understand the process:
112
112
- Use `quarto render` in the Terminal to build your outputs (HTML, PDF).
113
113
3.**Stop:** Use `docker/stop.bat` or `docker/stop.sh` when done.
-**R Package Management:**`renv` is pre-configured.
119
119
-**Library Path:**`/renv/library` (Mounted as a Docker volume for persistence).
120
120
-**Cache Path:**`/renv/cache` (Mounted as a Docker volume for faster reinstalls and sharing between projects).
121
121
-**Packages:** Core packages defined in `renv.lock` are restored during the Docker image build for the first render.
122
-
-**LaTeX/TinyTeX:** Essential LaTeX packages (`amsfonts`, `unicode-math`, `booktabs`, `caption`, `float`) are pre-installed in the Docker image.
122
+
-**LaTeX/TinyTeX:** Essential LaTeX packages are pre-installed in the Docker image and persist in the `texlive_data` volume.
123
123
-**Data Persistence:** Your project directory (`..` relative to `docker/`) is mounted to `/home/rstudio/project`.
124
124
-**RStudio Settings Persistence:** RStudio configuration (`.config`, `.local`, `.rstudio`, `.R`) is stored in `docker/cache/` and mounted into the container, preserving your layout and preferences per project.
125
125
-**Port Management:** The `start` scripts automatically find an open port starting from `127.0.0.1:8787`.
126
126
127
-
## Useful Commands {#useful-commands}
127
+
## Useful Commands
128
128
129
129
-**Inside RStudio Terminal:**
130
130
-`quarto render`: Render the entire book/project.
@@ -138,7 +138,7 @@ If you prefer manual control or want to understand the process:
138
138
-`docker volume ls`: List Docker volumes (to see `renv_cache`, `renv_library`).
139
139
-`docker volume prune`: Remove unused Docker volumes (use with caution).
140
140
141
-
## Troubleshooting {#troubleshooting}
141
+
## Troubleshooting
142
142
143
143
-**Docker not running:** Ensure the Docker Desktop application (or Docker daemon on Linux) is started.
144
144
-**Port in use:** The `start` scripts automatically find the next available port. Check the terminal output for the URL.
@@ -149,7 +149,7 @@ If you prefer manual control or want to understand the process:
149
149
-**Packages not found after restart:** Ensure `renv` is activated (opening `article-template.Rproj` usually does this) and run `renv::restore()` if needed.
150
150
-**RStudio settings not persisting:** Ensure the `docker/cache` directory exists and has the correct permissions.
151
151
152
-
## Publishing Your Article {#publishing-your-article}
152
+
## Publishing Your Article
153
153
154
154
This template is configured for easy publication on GitHub Pages using GitHub Actions.
155
155
@@ -172,15 +172,15 @@ This template is configured for easy publication on GitHub Pages using GitHub Ac
172
172
5.**View Your Site:**
173
173
- After the workflow completes successfully, your site will be available at `https://<your-github-username>.github.io/<your-repo-name>/`.
174
174
175
-
## Important Notes {#important-notes}
175
+
## Important Notes
176
176
177
177
-**Project Structure:** The main narrative files (`.qmd`) and configuration (`_quarto.yml`, `references.bib`, etc.) are in the **root** of the repository. Docker mounts this root directory to `/home/rstudio/project` inside the container.
178
178
-**Docker Context:** The `docker-compose.yml` uses `..` (the project root) as the build context, allowing the Dockerfile to access files like `renv.lock`.
179
179
-**renv:** This template relies heavily on `renv` for reproducibility. Familiarize yourself with its basic usage (`snapshot`, `restore`).
180
180
-**Git Integration:** While the Docker environment provides isolation, you should still use Git locally on your host machine for version control of your project files.
181
181
-**Administrative Files:** The `Adm/` folder is intended for administrative files and is ignored by Git (via `.gitignore`) and not published to GitHub Pages.
182
182
183
-
## Citation {#citation}
183
+
## Citation
184
184
185
185
If you use this template, please cite it as:
186
186
@@ -208,6 +208,6 @@ Limongi, R., & Rogers, P. (2025). Open Science in Three Acts: Foundations, Pract
208
208
209
209
Limongi, R., & Rogers, P. (2025). Open Science in Three Acts: Foundations, Practice, and Implementation - First Act. *BAR - Brazilian Administration Review*, *22*(1), e250079. <https://doi.org/10.1590/1807-7692bar2025250079>
210
210
211
-
## License {#license}
211
+
## License
212
212
213
213
This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License - see the [LICENSE](LICENSE) file for details.
0 commit comments