cynthiahqy / monash-quarto-aea

Materials for Open and Reproducible Research Websites workshop presented Jul 18-20 for the Department of Economics, Monash University

Meeting AEA Replication standards using Quarto and GitHub

Materials for Meeting AEA Replication standards using Quarto and GitHub workshop presented Jul 18-20 for the Department of Economics, Monash University

These materials are adapted from “Materials for the ‘Reproducible Documents, Websites, and Books with Quarto’ workshop at SDSS 2023.” by Mine Çetinkaya-Rundel, used under CC BY 4.0. These materials are licensed under CC BY 4.0 by Cynthia Huang.

monash-quarto-aea's Issues

Post-Workshop Survey

• @cynthiahqy ask Mine for template

Session 01: Intro to Quarto

Articles

• https://mine.quarto.pub/quarto-sdss/1-4-articles/

update blurb & program for flyer (@cynthiahqy 14 June)

• Change workshop title
• ADD updated program // session titles
• rewrite blurb to be less Quarto/technically focused -- more on replication AEA
• replicable research, data and code for econ journals

Live Websites

Key dates

• #4
• update workshop form -- room H4.87 (@L-Puzzello 15 June)
• reminder email and flyer (@L-Puzzello 15 June)
• pre workshop materials (@cynthiahqy 03 July -- 07 July)
• reminder email @L-Puzzello (Jul 11)
• day-one materials (session 1 & 2) -- @cynthiahqy 10-12 Jul
• day-two & three materials (sessions 3 & 4) -- @cynthiahqy 13-14 Jul
• ? send materials to Mine?
• Workshop date 18 Jul
• signup form: https://docs.google.com/forms/d/1asbEuP4d2Ioj1u1VKLRXWN6TfviKRxG2Mv29J3D0aKA/edit

Useful Links

https://www.bitss.org/opportunities/

Fresh-Web

project:
  type: website
  resources:
    - "**/*.pdf"

website:
  title: "fresh-web"
  navbar:
    left:
      - href: index.qmd
        text: Home
      - about.qmd
    right:
      - text: "More"
        menu: 
          - text: Extra
            file: extra.qmd
          - text: CV
            href: assets/CV.pdf
          - about.qmd
  sidebar:
    contents: posts

format:
  html:
    theme: cosmo
    css: styles.css
    toc: true

editor: visual

Session 02: AEA Replication Package

• https://datacodestandard.org/about/
• possible data/code package: https://www.openicpsr.org/openicpsr/project/189602/version/V1/view
• include-code-files, and filename= features

AEA journal templates

For the Articles section of session 1

• @L-Puzzello please share available templates
• https://www.aeaweb.org/journals/policies/templates

Listings

https://quarto.org/docs/websites/website-listings.html

Example Quarto Projects

Websites:

• Quarto Website Gallery: https://quarto.org/docs/gallery/#websites
• Awesome Quarto: https://github.com/mcanouil/awesome-quarto#websites-formats

Notes from Discussion with Mine

• Prework: https://mine.quarto.pub/quarto-sdss/pre-work.html // I will be there early to help you!
• IDE: VSCode or RStudio?
• visual mode
• try to avoid troubleshooting for the first half hour
• webhosting -- GitHub Pages
• bring a project with scripts folder! -- i.e. something like: https://aeadataeditor.github.io/aea-de-guidance/preparing-for-data-deposit.html
  • exclude: STATA scripts?
• quarto template / github --- GUI git clone; git template repository!
• keep them out of terminal as much as possible!
  • quarto publish
• pieces of the end goal -- explain each piece; adding extra pages etc.,
• highlight:
  • HTML options; metadata fields
  • source mode debugging
  • accessibility features
  • theming

doing a multi-day workshop: - allocate WRAP-UP - post materials day by day - leave the room during breaks

• Engagement
  • show a timer during YOUR TURN breaks
  • keep the talks short
  • stretch goals!
  • sticky on the back of laptops
  • now show to the person next to you!
• normally -- what to teach but not this time!
  • executable: code chunks
  • journal articles