IT platform guide - uchicago-bfi-gnlab/lab_manual GitHub Wiki

Table of Contents

Google Docs

  • We record meetings in google docs as “yyyy-mm-dd person project”
  • If there are todo items from the meetings, those are logged in github, not here
  • We also use google docs as todo list trackers for a project

Slack

  • We use slack to keep each other posted about things
  • Slack is not a system of record. Anything important that we will want to reference in the future should go in github.

Overleaf

  • We write papers and slides in overleaf
  • Comment threads for work inside firewalls also will sometimes live in Overleaf
    • All such threads live inside an appropriate issue folder named gh_issue_XXX_brief_description for GitHub tickets, and jira_issue_XXX-brief_description for JIRA ones. No lone .tex files.
  • Overleaf has a hard limit of 2000 files. If this is gating, go back to old output and see if you can delete anything. Before doing so, ensure that any .tex memo using exhibits that you are deleting is saved as a PDF and put in an archive subfolder inside the issue folder.

Lyx

  • We also sometimes write papers and slides in Lyx

Disclosures from Chase

  • Files go in analysis/input/disclose/<date>/ in master branch
    • for tex tables and individual pdf plots, make a second copy of these files in the the analysis/input/disclose/latest/ folder. (do not put Excel workbooks, PDF chartbooks and HTML renderings of tables into this folder.)

Lab Storage

  • Github
    • Project repo -- code, statistical output, paper, slides. To keep the repo lightweight, large files (> 100MB) are stored in a separate repo named data_<type_of_data>. When accessing these data, use a name like outside_data_path to describe the file path for the data in order to clarify that you are using data not included in the repo.
    • Data repo
  • Google Drive
    • Google docs (e.g. notes and meetings)
    • Prior literature
    • Correspondence
    • Anything not explicitly allocated to github

Releases

Rule of thumb: Material being actively being edited lives on github. Read-only material lives in archive folder on Overleaf.

Incoming correspondence like editor and referee letters go in google drive folder for the project. The same is true for meeting notes and to-do list trackers.

Paper

  • Every release goes through the “paper production” process
  • The pull request that merges the paper_production branch into master should be tagged with the label paper_release

Slides

  • Every presentation gets a ticket
    • whose issue title is the date of the presentation and the location (e.g. 2018-11-02 uillinois)
    • a "slides" label
  • After presentation, create a pull request
    • if "main" deck, create a pull request and merge to master
    • If “one-off” deck, delete branch
  • If you want to update a “one-off” deck
    • go to list of branches (linked above) and restore that branch
    • make a new branch off the restored branch
    • merge in changes from master
⚠️ **GitHub.com Fallback** ⚠️