A skeleton directory to jumpstart an analysis project

Setup

1. Start a New Project in Rstudio
2. Use Version Control > Git > Repo Url https://github.com/statsccpr/proj_skel.git
3. Use a relevant domain-specific name for your local project (NOT proj_skel)
4. Choose local destination for your local project

• Note: uses /proj_skel/.Rprofile which you can modify

Instructions

• place chickenscratch prototype scripts in /tests/proto/
• place good-standing scripts in /scripts/
• place raw data in /data/raw/
• place processed data in /data/proc/
• place output in /output/
• place writeup in /writeup/
• formal assertion-travisci tests in /tests/

Optional local offline clone (fork)

In destination directory, use command in command line git clone \..\source\.git \..\destination\

see this for local clone

Optional push to Github

• push your local project to new github repo (NOT proj_skel)

0. login github
1. create a new github repo https://github.com/new
2. See this

• The remote repo destination likely already exists (the template repo) so remove it, if cloned project template from github (via Setup section)
  • git remote -v show
  • git remote rm origin
• tell local git where to look on github (new repo from step 1)
  • git remote add github git@foo_new_name_from_step_1
• push local git to remote github
  • git push -u github master

3. See general reference on remote repos

Optional Collaboraters

1. Tell collaborators to Fork your github repo as their own local repo
2. They make changes and Push to their own global repo
3. Everyone can New Pull Request > Compare Across Forks
4. Pull head fork edits (yours) into base fork edits (theirs)