This repository may be useful to start a new analytical project.
git clone https://github.com/hirotaka-i/new_analysis.git
Cloned files
- README.md
- requirements.txt
- .gitignore
Cloned folders
- code: code snipets
- report: summary and reports
In addition, the following untracked folders
- data: folder to store the input data (untracked)
- priv: working files which should not be copied in the public GitHub
- temp: temporary files generated from input (untracked)
data/temp: These folders are not tracked for 2 reasons - (1) The data can be very big. (2) The data cannot be sharable. If the analysis requires the data in these folders, manual copying is required.
priv: Also not tracked. Remove from .gitignore if the repository is private.
- Change the folder name as appropriate.
- Initialize the folder.
- Connect to the appropriate GitHub repository.
- Modify files/folder structures as needed.
- push it to the GitHub
rm -rf .git # remove the git history
git init
git remote add origin <your remote GitHub repository>
# modify folder/data/etc
git add *
git commit -m 'first commit'
git push origin main
python3 -m venv .venv
source .venv/bin/activate # Mac
python -m pip install --upgrade pip
python -m pip install -r requirements.txt
pip install <package name>
pip freeze > requirements.txt # update the file
Once complete the set-up, delete the above and start your own README.md