jeffreyguntzel / d-lab-workshop-template

This repository serves as a template for all D-Lab workshops stored on GitHub. Use this template if you're creating a new D-Lab workshop.

D-Lab [WorkshopName] Workshop

This repository contains the materials for D-Lab [WorkshopName] workshop. We recommend attending D-LabWorkshop1, D-LabWorkshop2, and AdditionalWorkshopsAsNeeded prior to this workshop.

Workshop Goals

In this workshop, we provide [WorkshopGoal]. First, we’ll cover [Aim1]. Then, we’ll explore [Aim2].

Only if necessary: If you are not familiar with material in D-LabWorkshop1, D-LabWorkshop2, and AdditionalWorkshopsAsNeeded, we recommend attending those workshops first.

Learning Objectives

After this workshop, you will be able to:

• [LearningObjective1].
• [LearningObjective2].
• [LearningObjective3].

This workshop does not cover the following:

• [NotCovered1]. These are covered in D-LabWorkshopName.
• [NotCovered2]. These are covered in D-LabWorkshopName.

Installation Instructions

We will use [RStudio/Python] to go through the workshop materials, which requires installation of [Software]. Complete the following steps:

1. This step(s) details software to download, with a link.
2. Download these workshop materials:
   • Click the green "Code" button in the top right of the repository information.
   • Click "Download Zip".
   • Extract this file to a folder on your computer where you can easily access it (we recommend Desktop).
3. Optional: if you’re familiar with git, you can instead clone this repository by opening a terminal and entering [GitCloneCommand].

Is [Language] not Working on Your Computer?

If you do not have [Language] installed and the materials loaded on your workshop by the time it starts, we strongly recommend using the UC Berkeley Datahub to run the materials for these lessons. You can access the DataHub by clicking the following button:

The DataHub downloads this repository, along with any necessary packages, and allows you to run the materials in an RStudio instance on UC Berkeley's servers. No installation is necessary from your end - you only need an internet browser and a CalNet ID to log in. By using the DataHub, you can save your work and come back to it at any time. When you want to return to your saved work, just go straight to the D-Lab DataHub, sign in, and you click on the [Workshop-Name] folder.

If you don't have a Berkeley CalNet ID, you can still run these lessons in the cloud, by clicking this button:

By using this button, however, you cannot save your work.

Run the Code

Now that you have all the required software and materials, you need to run the code:

Provide instructions on running the code, including how to load relevant software (RStudio, Jupyter Notebooks, etc.) and which file to open up. See other repositories for examples.

Additionally, provide instructions on how to run code once it’s open (running Jupyter cells, RMarkdown cells, etc.).

Additional Resources

Check out the following resources to learn more about [Workshop topics]:

• Resource1: Explain Resource 1
• Resource2: Explain Resource 2
• [...]

About the UC Berkeley D-Lab

D-Lab works with Berkeley faculty, research staff, and students to advance data-intensive social science and humanities research. Our goal at D-Lab is to provide practical training, staff support, resources, and space to enable you to use R for your own research applications. Our services cater to all skill levels and no programming, statistical, or computer science backgrounds are necessary. We offer these services in the form of workshops, one-to-one consulting, and working groups that cover a variety of research topics, digital tools, and programming languages.

Visit the D-Lab homepage to learn more about us. You can view our calendar for upcoming events, learn about how to utilize our consulting and data services, and check out upcoming workshops.

Other D-Lab [Language] Workshops

Here are other [Language] workshops offered by the D-Lab:

Basic Competency

Provide a list of workshops here.

Intermediate/Advanced Competency

Provide a list of workshops here.

Contributors

Provide a list of contributors here, with links to their webpages (D-Lab or private).