diff --git a/README.md b/README.md index 80c6ef5..738e0a0 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ If you are interested in joining, please go [here](https://advance.hub.phuse.glo Take a look to the [website](https://phuse-org.github.io/git-in-statistical-programming/) (made with Quarto). -# Objectives and Deliverables +## 1. Objectives and Deliverables 1. Principles for using Git and example workflow(s) in context of the current QC process @@ -27,15 +27,64 @@ Take a look to the [website](https://phuse-org.github.io/git-in-statistical-prog 3. Core education on Git for statistical programmers 4. Soft proposal for an alternative QC process using Git features -# R use +## 2. How to Contribute -This repository will be using quarto. To support this, there is an renv lock file which is currently bare bones. +You can get involved in one of the following ways -# How to Contribute +2.1 - If you wish to join the working group please [go here](https://advance.hub.phuse.global/wiki/spaces/WEL/pages/90472449/The+Use+of+Git+in+Statistical+Programming) for the leads to reach out to them +2.2 - You can get involved in discussion via the issues +2.3 - You can propose a merge request via a fork if you see something that needs fixing -You can get involved in one of the following ways -- If you wish to join the working group please [go here](https://advance.hub.phuse.global/wiki/spaces/WEL/pages/90472449/The+Use+of+Git+in+Statistical+Programming) for the leads to reach out to them -- You can get involved in discussion via the issues -- You can propose a merge request via a fork if you see something that needs fixing +### 2.3. Using Git, to propose changes! + +#### 2.3.1 About cloning, branching and pushing + +Basic steps to get into this "Git world" + +0- Ensure you have installed Git, and you use the terminal to go to your favorite directory. + +1- Clone the repo from your terminal `git clone https://github.com/phuse-org/git-in-statistical-programming.git` + +2- Create a branch with your username `git checkout -b yourname_dev` All the changes and contributions will be done here + +3- once this is done, add changes to stage `git add .` + +4- once this is done, commit the changes with a message `git commit -m " i did this change (your summary of the changes)" + +5- finally push the changes! `git push origin yourname_dev` + +6- if you go now to the repo https://github.com/phuse-org/git-in-statistical-programming.git you will see at the top a message saying your changes has been pushed into your named branch. + +7- if you want your changes being in the "main" branch (default page), you have to create a merge request. (green button top right saying "compare & pull request") + + + +💡NOTE: If you like to use your Chat GPT to teach you more about these steps, use it. No fear to break anything! +💡NOTE2: There is a wonderful tutorial in [Coursera] (https://www.coursera.org/learn/making-data-science-work-for-clinical-reporting#modules) to practise on your own how to do these steps. Very easy and well explained (and you get a certification 🎓 at the end!) + +#### 2.3.2 About R + +This repository will be using quarto. To support this repository, there is an **renv lock** file which is currently bare bones. +(This means we can keep traceability of the R packages we are using within this repo) + +```R +# reinstall environment packages +renv::restore() # to install packages required + +# if you made changes to the environment (installing new packages) you can save them by: +renv::snapshot() + +``` + +For the poster it would be nice to have some stats in a jupyter or Rmarkdown about issues around Git (or some charts explaining key points). +To start with, +0 - clone the repo in your laptop +1 - create your own git branch: +```sh +# in terminal, within your project directory +git checkout -b yourname_dev +``` +2- A folder called **"script_ideas"** will be the SANDBOX with your scripts/ collaborative scripts/pictures to get some charts/numbers around this topic (for the paper or poster, or to discuss in our meetings). + diff --git a/script_ideas/croca_git_numbers.qmd b/script_ideas/croca_git_numbers.qmd new file mode 100644 index 0000000..773cf1c --- /dev/null +++ b/script_ideas/croca_git_numbers.qmd @@ -0,0 +1,43 @@ +--- +title: "croca_git_numbers" +author: "croca" +format: html +editor: visual +jupyter: python3 +--- + +## Idea 1. Git in numbers + +Try to get some real world numbers around Git +(So far I will focus in Github) + +### How is the adoption of Git around the world from the last 5 years till now? + + +- We can see that the adoption increase across the world since 2020 till 2025 + + +![innovationgraph](img/adoptionByOrganizationsInWorld_last5years.png) + + + +### How many "statisticians in healthcare" use Git. + + + +## Running Code + +When you click the **Render** button a document will be generated that includes both content and the output of embedded code. You can embed code like this: + +```{python} +1 + 1 +``` + +You can add options to executable code like this + +```{python} +#| echo: false +2 * 2 +``` + +The `echo: false` option disables the printing of code (only output is displayed). diff --git a/script_ideas/img/adoptionByOrganizationsInWorld_last5years.png b/script_ideas/img/adoptionByOrganizationsInWorld_last5years.png new file mode 100644 index 0000000..b6e260b Binary files /dev/null and b/script_ideas/img/adoptionByOrganizationsInWorld_last5years.png differ