1. GETTING STARTED#
=======1. GETTING STARTED#
>>>>>>> origin/main1.1. Introduction#
This document serves multiple purposes. As an onboarding guide for new research assistants, its aim is to introduce the research tools I use and how to get started with these tools. I also try to describe a standard for good research habits. As a reference manual, this document serves as a resource and first line of defense when questions arise.
1.1.1. How To Use This Manual#
Read the Table of Contents to learn what’s covered in the handbook and where to find it. For detailed contents, go to relevant chapter and look at table of contents to the right side of the page.
Read the Setup Guide and follow the instructions in first things first.
Read Gentzkow & Shapiro, Code and Data for the Social Sciences Download
Complete the steps to set up each of the tools.
In the future, when you have questions, start by looking back here for answers.
1.1.2. Commandments for Productive Coding#
Nobody really sticks to these fully, but everyone should be striving to adhere to the following three principles. The more you stick to them, the more productive and efficient we can be.
Don’t Repeat Yourself: Put your work in a place where you can find it later. Turn repetitive tasks into functions and groups of repetitive tasks into modules. Write code that writes code.
Plan to Rewrite: Rewriting is a fact of life. Fix “broken windows” now. Expect to rewrite and reorganize code as projects evolve. Don’t plan to “come back and tidy that up later”, do it now before moving on to something else.
Write Code that Others Can Read and Use: For all code you write, adhere to a consistent set of readability rules. Add in more comments than you think are necessary; others (including your future self) will thank you!
1.2. Setup Guide#
1.2.1. First Things First#
Do some of the recommended readings in chapter 20, especially Read Gentzkow & Shapiro, Code and Data for the Social Sciences PDF. Pay close attention to their guidelines regarding code style, documentation, version control, and task management.