Skip to content

Releases: phdpablo/article-template

ARTE v2.1

19 Jan 18:01
b896e47

Choose a tag to compare

ARTE v2.1.0 Release Notes

We are pleased to announce the release of ARTE (Article Reproducibility Template & Environment) v2.1.0!

This release introduces cloud-based reproducibility verification via MyBinder, significantly improves the GitHub Actions deployment workflow, and updates key dependencies including a major ggplot2 upgrade.

✨ Key Features

Cloud-Based Reproducibility Verification (MyBinder)

  • New MyBinder integration allows anyone to verify the computational workflow without local installation
  • One-click browser-based access to a complete R/RStudio/Quarto environment
  • New .binder/ folder with:
    • Custom Dockerfile based on rocker/binder: 4.4.2
    • Comprehensive README.md with step-by-step instructions
  • Ephemeral environment ideal for reproducibility verification and exploration

Optimized GitHub Actions Workflow

  • Intelligent caching for TinyTeX, Quarto, and R packages significantly reduces build times
  • Integration with r-lib/actions/setup-renv@v2 for automatic package restoration from renv.lock
  • Switched from full TeX Live to lightweight TinyTeX installation
  • Added GITHUB_PAT environment variable for authenticated operations
  • Updated documentation for gh-pages branch setup

Docker Improvements

  • New texlive_data volume for persistent LaTeX distribution across container recreations
  • Added tlmgr update step before installing LaTeX packages
  • Additional LaTeX packages: pgf, environ, pdfcol, fontawesome5, tcolorbox
  • Simplified Dockerfile by removing redundant renv setup

📦 Dependency Updates

Major Updates

  • ggplot2: 3.5.2 → 4.0.1 (major version upgrade with S7 OOP system)
  • renv: 1.1.4 → 1.1.5

New Dependencies

  • S7: New object-oriented programming system (required by ggplot2 4.x)
  • cpp11: C++11 interface for R

Streamlined Dependencies

  • Removed non-essential packages from renv.lock: MASS, Matrix, mgcv, nlme, lattice, tibble, pillar, magrittr, pkgconfig, utf8
  • Leaner dependency tree improves installation times and reduces potential conflicts

📝 Documentation Enhancements

New Content

  • Video tutorials added to the homepage:
    • English presentation video
    • Portuguese tutorial for Brazilian audience
  • MyBinder sections added throughout the article (Introduction, Background, Methods, Results, Conclusion)
  • Conceptual summary link to the three BAR editorials
  • Course reference for Portuguese speakers

Updated Resources

  • Updated Zenodo DOI links for ARTE workflow illustrations
  • Refreshed figures: arte-folders.jpg, roadmap1.jpg, roadmap2.jpg
  • Updated references.bib with complete volume/number information

Improved Instructions

  • Clearer GitHub Pages deployment instructions
  • Added note about creating gh-pages branch if it doesn't exist
  • Updated workflow README with better formatting

⚙️ Configuration Changes

Quarto Configuration (_quarto.yml)

  • Added freeze: auto for automatic code execution management based on source changes
  • Changed default editor from visual to source mode

Git Configuration

  • Added _freeze/ to .gitignore

🔗 Resources

📚 Citation

If you use this template, please cite:

Rogers, P., & Limongi, R. (2025). Open Science in Three Acts: Foundations, Practice, and Implementation - Third Act. BAR - Brazilian Administration Review, 22(3), e250162. https://doi.org/10.1590/1807-7692bar2025250162


We hope ARTE v2.1.0 makes reproducible research even more accessible by enabling cloud-based verification alongside local Docker environments.

ARTE: Article Reproducibility Template & Envorinment

04 Sep 17:33

Choose a tag to compare

ARTE v2.0.0 Release Notes

We are pleased to announce the release of ARTE (Article Reproducibility Template & Environment) v2.0.0!

This major update introduces significant enhancements focused on improving the user experience, streamlining the workflow for reproducible research, and providing better support for the TIER Protocol 4.0 structure. This version builds upon the foundation laid in v1.x, incorporating feedback and advancements in reproducible research tools.

Key Improvements in v2.0.0

  • Enhanced Docker Workflow: The Docker configuration (docker/ folder) has been significantly refined for easier setup and more robust persistence of both project files and R environments. New launcher scripts (start.bat, start.sh, stop.bat, stop.sh) provide a one-click experience for starting and stopping the RStudio environment.
  • Improved Project Structure Adherence: Folder structures and README.md files throughout the template (Data/, Scripts/, Output/, etc.) have been reviewed and updated to align even more closely with TIER Protocol 4.0 guidelines, making project organization clearer.
  • Integrated Quarto Book Example: The template now includes a more complete example Quarto book project (index.qmd, 01-intro.qmd, etc.) demonstrating best practices for integrating narrative, code, and results within the TIER structure.
  • Streamlined Dependency Management: The renv setup process has been clarified, ensuring dependencies listed in renv.lock are correctly restored within the Docker environment, facilitating Proper and Full Reproducibility.
  • Automated Cleanup: A new render_cleanup.R script is included to automatically remove temporary and intermediate files generated during Quarto rendering, keeping your project tidy.
  • Updated Documentation: Comprehensive README.md files have been added or revised across the repository, providing clearer instructions for getting started, using Docker for Full Reproducibility, and understanding the purpose of each project component.

How to Access ARTE v2.0.0

  • GitHub Repository: The latest version of the template is available on GitHub: https://github.com/phdpablo/article-template. Use git tag v2.0.0 to checkout this specific release.
  • Citing ARTE: If you use this template, please cite the associated editorial:

Resources

We hope ARTE v2.0.0 helps researchers create more robust, transparent, and reproducible dynamic articles.

TIER Protocol 4.0: Dynamic Template

12 Aug 15:45

Choose a tag to compare

This template was developed to assist researchers use Quarto and RStudio to build a dynamic and reproducible article. It is integrated with Git/GitHub for version control, OSF and GitHub Pages for sharing, and the TIER Protocol 4.0 for project organization. The template provides an organized method that satisfies the Minimal, Proper, and Full criteria of reproducibility. It can also be combined with Docker and the R renv package for environment control. Visit the project template also at: https://osf.io/njdq5/

Quarto Article Template

01 Jan 22:47
bf8a0fb

Choose a tag to compare

Add Zenodo All version DOI reference

Second version

29 Dec 19:33

Choose a tag to compare

Adjusted version after initial commit. Basically adjusting the template structure.

First version

29 Dec 19:10
3098204

Choose a tag to compare

First version Pre-release
Pre-release

First version based on smart-cfa template.