In this lab, you will be using Git and Github to fork, clone, commit, and push changes to a repository. The repository you will select to use as the repository to fork to your own Github account can be one of the following:
If you are starting with a new repository, fork and clone the repository you selected to your local machine. Then orient yourself to the repository by opening the README file and reviewing the template configuration.
If you are using an existing reproducible research project repository, open that project on your local machine, and pull
the latest changes from the remote repository to ensure that your local and remote repositories are in sync.
Open a Quarto document in the process directory and name it accordingly (e.g., 1_acquire.qmd
, data_collection.qmd
, etc.).
The data you select to acquire can be through manual or programmatic download or through an API. If you do not have a resource in mind, you may select one of the following:
gutenbergr
package)In your acquisition process file,
add a section which provides a brief description of the data you are collecting. Include:
add a section for the data collection process. In this section, you will document with code, code comments, and prose the process of collecting the data. This is where you will craft the code to collect the data. Feel free to use existing R packages and functions as you see fit. You may use any of the following strategies to collect the data:
Make sure to organize your data collection process in a way that is reproducible. This means that you should be able to run the code in your data collection process file and reproduce the data collection process. Use the data/original
(or similar) directory to store the data you collect.
Make sure that your code is well documented with code comments and that you have included prose to describe the process of collecting the data.
Include a section to describe the resulting data and to display the data origin file you have created for this data as a table.
Confirm that your code runs without errors and that the data is collected and displayed as expected.
Finally, commit and push your changes to your Github repository. Make sure to include files or directories that you do not have permission to share in your .gitignore
file.
Some questions to consider:
This work is licensed under a Creative Commons Attribution 4.0 International License.