This directory contains all datasets and supplementary materials which are essential for the course. The files here support the learning objectives and provide the necessary resources for attendees.
- Datasets (CSV, JSON, SAM, FASTA etc.)
- Reference/supplementary data
- Practical exercise data
To ensure clarity and consistency, please follow these naming conventions for your files:
- Use descriptive names that reflect the content (e.g.,
dataset_experiment_1.csv
,image_treatment_protocol.png
). - Use lowercase letters and separate words with underscores (_) for better readability.
- Include version numbers if necessary (e.g.,
data_v1.0.csv
).
- Files under 25MB can be uploaded via the web interface.
- Files up to 100MB can be uploaded using the Git command line.
- For files larger than 100MB, use Git Large File Storage (LFS) to manage your uploads.
- Navigate to the Repository: Go to the GitHub repository for the course.
- Select the course_data Directory: Click on the course_data folder to open it.
- Click on "Add file": On the right-hand side, you’ll see an option labelled Add file.
- Choose "Upload files": From the dropdown menu, select Upload files.
- Drag and Drop or Select Files: You can either drag and drop your files into the space provided or click choose your files to upload them from your computer.
- Commit Changes: Once your files are uploaded, scroll down to the Commit changes section.
- Enter a brief description of the changes in the commit message field (e.g., "Adding new dataset files").
- Click Commit changes to finalize your upload.
-
Install Git LFS.
-
Clone the repository.
-
Copy your large files to the respective
course_data
directory. -
Track the suffix of large files using the following command:
git lfs track "*.sam"
-
Then add the .gitattributes, commit, and push:
git add .gitattributes
git commit -m "Now tracking sam files"
git push
-
Now add your files, then commit and push:
git add course_data/dir/file.sam
git commit -m "Adding big sam file"
git push
NB: Git LFS does NOT track changes in binary files—use different names for modified files.
The Software Informatics Guide provides comprehensive information about the software utilized by participants throughout the course, including version numbers, links to software repositories or websites, and other relevant details. The training team is encouraged to review this guide and add their software, as this will be beneficial for course attendees in the future. The link to this guide can be found on the course homepage.
- Using Markdown on GitHub
- Formatting markdown on GitHub
- GitHub Markdown Cheatsheet
- Command Line GitHub Manual
- Git Large File Storage (LFS)
Wellcome Connecting Science GitHub Home Page
Wellcome Connecting Science Courses & Conference Website