This homework will assess your ability to use GitHub, organize projects, and apply tidy data principles, and represents content covered in lecture 3. Fill this README.md document with your answers below and upload this file to Canvas.
15 points
Make a GitHub account and populate your bio by including your research interests, place of work, location, professional webpage (or science-focused twitter account!). Here's an example github.com/trvrb.
Include the link to your GitHub profile here.
15 points
This question assesses your ability to track a project using Git.
Download the course files with the following link: github.com/FredHutch/tfcb_2023/archive/refs/heads/main.zip. Copy the contents of homeworks/homework01/messy-project-directory/
to a new directory on your computer named tfcb-homework01
.
Open the above tfcb-homework01
in VSCode and "Initialize Repository" in the Source Control Tab.
Create an initial commit that adds all the local files in tfcb-homework01
:
Survey Data.xlsx
get Species_list.py
- etc...
You do not need to submit anything for this problem; your success will be evaluated in the next problem.
15 points
This question assesses your ability to publish projects to GitHub.
Create a new repository on GitHub called tfcb-homework01
.
Make sure to set this to be a "public" repository.
The resulting repository can now be accessed at github.com/{your_username}/tfcb-homework01
.
If necessary, you can make this repository public by going to "Settings" from this page.
Push the local tfcb-homework01
to GitHub.
Do this by picking Push
from the ...
icon in the Source Control Tab of VSCode.
The first time you try doing this, you will get an error asking you to configure your "Remote".
Use the URL of the GitHub repository you created above to configure the Remote.
Now you should be able to push any further changes to your repository.
Include the link to your tfcb-homework01
GitHub repository here.
15 points
This question assesses your ability to organize files and directories associated with research projects.
Organize files into a more consistent structure. Group images into a images/
directory. Separate source code and data. Rename files to remove spaces and improve consistency. Commit changes and publish to your public GitHub repository.
Include the link to your tfcb-homework01
GitHub repository here.
20 points
This question assesses your ability to write a README with Markdown formatting.
Create a file called README.md
and populate with Markdown. Demonstrate headers, lists, links, embedded images (by linking to images contained in the directory) and tables in this readme.
Commit this file and publish to your public GitHub repository.
Include the link to your README.md
here.
20 points
This question assesses your understanding of tidy data principles.
Clean up the file that was originally named Survey Data.xlsx
. Some points to remember: aim for a single tidy data frame in a single tab, don't use formatting as data, use preferred date format, properly record null values.
Export this as a tab-delimited .csv
text file with Unix line endings.
Commit the modified .xlsx
file and the .csv
file and publish to your public GitHub repository.
Include the link to your .csv
file on GitHub here.