documentation and updated csv file for research software repositories

Software-Engineering-Group-UP · Jun 12, 2024 · a5e9223 · a5e9223
1 parent f09b353
commit a5e9223
Show file tree

Hide file tree

Showing 8 changed files with 1,580 additions and 832 deletions.
diff --git a/README.md b/README.md
@@ -5,16 +5,16 @@ This repository contains the data and findings for paper
 ## Contents
 
 1. `data/`: This directory contains the raw data collected from the research repositories.
-The data (conly ***research*** repositories) used in this project can be found in the [final_data_publish.csv](data/final_data_publish.csv) file.
+The [all_research_repos.csv](data/all_research_repos.csv) file specifically contains data used in this analysis, which is limited to ***research*** repositories. 
+(Note: The files [all_org_repos.csv](data/all_org_repos.csv.csv) and [all_user_repos.csv](data/all_user_repos.csv) include repositories labeled as research/non_research)
 2. `analysis/`: This folder contains plot_analysis.ipynb file with graphs/plots used in paper. 
 The analysis and result graphs can be found in the [plot_analysis.ipynb](analysis/plot_analysis.ipynb) Jupyter notebook.
 3. `scripts/`: This directory contains the code code used for plotting graphs in jupyternotebook. 
 
 
-
 ## Methodology
 
-Data collection using SWORDS
+ [SWORDS-template-UP](https://github.com/Software-Engineering-Group-UP/SWORDS-template-UP) have been used for gathering GitHub profiles, repositories and additional software developement variables. This is an exteded version of [SWORDS-template-UP](https://github.com/UtrechtUniversity/SWORDS-template) 
 
 ## Usage
 
@@ -29,4 +29,4 @@ This repository is licensed under a [Creative Commons Attribution 4.0 Internatio
 ![Creative Commons License](https://i.creativecommons.org/l/by/4.0/88x31.png)
 
 ## Citation 
-Please cite it as described in the [CITATION.cff](CITATION-4.cff) file.
+Please cite it as described in the [CITATION.cff](CITATION.cff) file.
diff --git a/analysis/plot_analysis.ipynb b/analysis/plot_analysis.ipynb
diff --git a/analysis/results/plot_comment_at_start.png b/analysis/results/plot_comment_at_start.png
diff --git a/analysis/results/plot_documentation.png b/analysis/results/plot_documentation.png
diff --git a/analysis/results/plot_fairness.png.png b/analysis/results/plot_fairness.png.png
diff --git a/analysis/results/plot_test.png b/analysis/results/plot_test.png
diff --git a/data/all_research_repos.csv b/data/all_research_repos.csv
diff --git a/data/final_data_publish.csv b/data/final_data_publish.csv