Update README.md
Browse filesAdding data dictionary.
README.md
CHANGED
|
@@ -1,3 +1,43 @@
|
|
| 1 |
-
---
|
| 2 |
-
license: cc-by-2.0
|
| 3 |
-
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: cc-by-2.0
|
| 3 |
+
---
|
| 4 |
+
|
| 5 |
+
### 📘 Data Dictionary for the Curated Class-level Dataset
|
| 6 |
+
|
| 7 |
+
| **Field** | **Description** |
|
| 8 |
+
|-----------|-----------------|
|
| 9 |
+
| `id` | A unique identifier for each data point, starting from 0. |
|
| 10 |
+
| `repository_name` | Name of the GitHub repository from which the class was extracted. |
|
| 11 |
+
| `file_path` | Full path to the file containing the class within the repository. |
|
| 12 |
+
| `class_name` | Name of the class defined in the corresponding file. |
|
| 13 |
+
| `human_written_code` | Full source code of the human-written class, including all docstrings. |
|
| 14 |
+
| `class_skeleton` | Extracted skeleton of the class, including class and method signatures along with associated docstrings (if present). |
|
| 15 |
+
| `total_program_units` | Total number of program units (i.e., classes and methods) within the class skeleton. |
|
| 16 |
+
| `total_doc_str` | Number of program units in the class skeleton that contain associated docstrings. |
|
| 17 |
+
| `AvgCountLine` | Average number of lines per class. |
|
| 18 |
+
| `AvgCountLineBlank` | Average number of blank lines per class. |
|
| 19 |
+
| `AvgCountLineCode` | Average number of code lines per class (excluding comments and blanks). |
|
| 20 |
+
| `AvgCountLineComment` | Average number of comment lines per class. |
|
| 21 |
+
| `AvgCyclomatic` | Average cyclomatic complexity across methods in the class. |
|
| 22 |
+
| `CommentToCodeRatio` | Ratio of comment lines to code lines in the class. |
|
| 23 |
+
| `CountClassBase` | Number of base classes (i.e., direct superclasses). |
|
| 24 |
+
| `CountClassCoupled` | Number of other classes referenced (coupled) by this class. |
|
| 25 |
+
| `CountClassCoupledModified` | Number of coupled classes after removing standard library dependencies. |
|
| 26 |
+
| `CountClassDerived` | Number of classes that inherit from this class. |
|
| 27 |
+
| `CountDeclInstanceMethod` | Number of instance methods declared in the class. |
|
| 28 |
+
| `CountDeclInstanceVariable` | Number of instance variables declared in the class. |
|
| 29 |
+
| `CountDeclMethod` | Number of methods declared in the class (excluding inherited ones). |
|
| 30 |
+
| `CountDeclMethodAll` | Total number of declared methods, including inherited ones. |
|
| 31 |
+
| `CountLine` | Total number of lines in the class. |
|
| 32 |
+
| `CountLineBlank` | Number of blank lines in the class. |
|
| 33 |
+
| `CountLineCode` | Number of executable code lines in the class. |
|
| 34 |
+
| `CountLineCodeDecl` | Number of declaration lines in the class. |
|
| 35 |
+
| `CountLineCodeExe` | Number of executable statement lines in the class. |
|
| 36 |
+
| `CountLineComment` | Number of comment lines in the class. |
|
| 37 |
+
| `CountStmt` | Total number of statements in the class. |
|
| 38 |
+
| `CountStmtDecl` | Number of declaration statements in the class. |
|
| 39 |
+
| `CountStmtExe` | Number of executable statements in the class. |
|
| 40 |
+
| `MaxCyclomatic` | Maximum cyclomatic complexity among all methods in the class. |
|
| 41 |
+
| `MaxInheritanceTree` | Maximum depth of the class in the inheritance hierarchy. |
|
| 42 |
+
| `MaxNesting` | Maximum level of nested control structures in the class. |
|
| 43 |
+
| `SumCyclomatic` | Sum of cyclomatic complexity across all methods in the class. |
|