Replication package of `Can We Automatically Generate Class Comments in Pharo?`

# RP Automatic-comment-generation
This folder contains all the material needed to replicate the experiments.
## Content
- [RP Automatic-comment-generation](#automatic-comment-generation)
    - Appendix.pdf
    - [Content](#content)
    - [Dataset/](#dataset/)
        - [Online evaluation/](#online-evaluation/)
    - [Results/](#results/)
        - [SI-Approach/](#SI-Approach/)

## Dataset/
This contains the data for the online evaluation
- #### Online evaluation/
    Contains set of questions used in online evaluation, results of these questions and lists of classes used for each online evaluation
    - [Class_understanding_questions.xlsx](RP-Automatic-comment-generation\Dataset\Online_evaluation\Class_understanding_questions.xlsx)
        Questions used to determin if a participant understood the functionality of a class.
    - [Q_and_A_class_comment_characteristics.xlsx](RP-Automatic-comment-generation\Dataset\Online_evaluation\Q_and_A_class_comment_characteristics)
        Questions and possible answers used for the evaluation of the characteristics adequacy, conciseness and comprehensibility of a generated class comment.
    - [Q_and_A_what_participants_write_and_look_for.xlsx](RP-Automatic-comment-generation\Dataset\Online_evaluation\Q_and_A_what_participants_write_and_look_for.xlsx)
        Questions and possible answers used to determine what participants look for and write in class comments.
    - [Classes_used_in_evaluation1.xlsx](RP-Automatic-comment-generation\Dataset\Online_evaluation\Classes_used_in_evaluation1.xlsx)
        Extracted classes with information to LOC, instance variables, number of methods, number of classes using it and class stereotypes for evaluation 1.
     - [Classes_used_in_evaluation2.xlsx](RP-Automatic-comment-generation\Dataset\Online_evaluation\Classes_used_in_evaluation2.xlsx)
        Extracted classes with information to LOC, instance variables, number of methods, number of classes using it and class stereotypes for evaluation 2.
     - [Classes_used_in_evaluation3.xlsx](RP-Automatic-comment-generation\Dataset\Online_evaluation\Classes_used_in_evaluation3.xlsx)
        Extracted classes with information to LOC, instance variables, number of methods, number of classes using it and class stereotypes for evaluation 3.
     - [Classes_used_in_evaluation4.xlsx](RP-Automatic-comment-generation\Dataset\Online_evaluation\Classes_used_in_evaluation4.xlsx)
        Extracted classes with information to LOC, instance variables, number of methods, number of classes using it and class stereotypes for evaluation 4.
     - [How_often_participants_write_comments.xlsx](RP-Automatic-comment-generation\Dataset\Online_evaluation\How_often_participants_write_comments.xlsx)
        Results for distribution of how often participants claim to write comments.
     - [How_participants_follow_class_comment_template.xlsx](RP-Automatic-comment-generation\Dataset\Online_evaluation\How_participants_follow_class_comment_template.xlsx)
        Results for distribution of how participants follow the class comment template.
    - [What_participants_look_for_in_comments.xlsx](RP-Automatic-comment-generation\Dataset\Online_evaluation\What_participants_look_for_in_comments.xlsx)
        Results of evaluation for what participants look for in class comments.
    - [What_participants_write_in_comments.xlsx](\RP-Automatic-comment-generation\Dataset\Online_evaluation\What_participants_write_in_comments.xlsx)
        Results of evaluation for what participants write in class comments.

## Results/
- #### SI-Approach/
    Contains all the data for the results related to SI-Approach and the scripts used to generate said data.
    - [Class_stereotype_distribution.xlsx](RP-Automatic-comment-generation\Results\SI-Approach\Class_stereotype_distribution.xlsx)
    Extracted class stereotypes for 350 random classes in the Pharo base image. Evaluated in 10 classes per step.
    - [Class_stereotype_script.txt](RP-Automatic-comment-generation\Results\SI-Approach\Class_stereotype_script.txt)
    Script used in the Playground of Pharo to return counts of how many classes get assigned the specific class stereotypes. Returns numbers for the class stereotypes in alphabetical order. Boundary => Small
    - [Method_stereotype_dstribution.xlsx](RP-Automatic-comment-generation\Results\SI-Approach\Method_stereotype_distribution.xlsx)
    Extracted method stereotypes for 500 random classes in the Pharo base image. Evaluated in 20 classes per step.
    - [Method_stereotype_script.txt](RP-Automatic-comment-generation\Results\SI-Approach\Method_stereotype_script.txt)
    Script used in the Playground of Pharo to return counts of how many methods get assigned the specific method stereotypes. Returns numbers for the method stereotypes in the order Accessors, Getters, Mutators, Setters, Collaborators, Controllers, Factories and Degenerate.

Replication package of 'Can We Automatically Generate Class Comments in Pharo?'

# RP Automatic-comment-generation
This folder contains all the material needed to replicate the experiments.
## Content
- [RP Automatic-comment-generation](#automatic-comment-generation)
    - [Content](#content)
    - [Dataset/](#dataset/)
        - [Online evaluation/](#online-evaluation/)
    - [Results/](#results/)
        - [SI-Approach/](#SI-Approach/)

## Dataset/
This contains the data for the online evaluation
- #### Online evaluation/
    Contains set of questions used in online evaluation, results of these questions and lists of classes used for each online evaluation
    - [Class_understanding_questions.xlsx](thesis\RP-Automatic-comment-generation\Dataset\Online_evaluation\Class_understanding_questions.xlsx)
        Questions used to determin if a participant understood the functionality of a class.
    - [Q_and_A_class_comment_characteristics.xlsx](thesis\RP-Automatic-comment-generation\Dataset\Online_evaluation\Q_and_A_class_comment_characteristics)
        Questions and possible answers used for the evaluation of the characteristics adequacy, conciseness and comprehensibility of a generated class comment.
    - [Q_and_A_what_participants_write_and_look_for.xlsx](thesis\RP-Automatic-comment-generation\Dataset\Online_evaluation\Q_and_A_what_participants_write_and_look_for.xlsx)
        Questions and possible answers used to determine what participants look for and write in class comments.
    - [Classes_used_in_evaluation1.xlsx](thesis\RP-Automatic-comment-generation\Dataset\Online_evaluation\Classes_used_in_evaluation1.xlsx)
        Extracted classes with information to LOC, instance variables, number of methods, number of classes using it and class stereotypes for evaluation 1.
     - [Classes_used_in_evaluation2.xlsx](thesis\RP-Automatic-comment-generation\Dataset\Online_evaluation\Classes_used_in_evaluation2.xlsx)
        Extracted classes with information to LOC, instance variables, number of methods, number of classes using it and class stereotypes for evaluation 2.
     - [Classes_used_in_evaluation3.xlsx](thesis\RP-Automatic-comment-generation\Dataset\Online_evaluation\Classes_used_in_evaluation3.xlsx)
        Extracted classes with information to LOC, instance variables, number of methods, number of classes using it and class stereotypes for evaluation 3.
     - [Classes_used_in_evaluation4.xlsx](thesis\RP-Automatic-comment-generation\Dataset\Online_evaluation\Classes_used_in_evaluation4.xlsx)
        Extracted classes with information to LOC, instance variables, number of methods, number of classes using it and class stereotypes for evaluation 4.
     - [How_often_participants_write_comments.xlsx](thesis\RP-Automatic-comment-generation\Dataset\Online_evaluation\How_often_participants_write_comments.xlsx)
        Results for distribution of how often participants claim to write comments.
     - [How_participants_follow_class_comment_template.xlsx](thesis\RP-Automatic-comment-generation\Dataset\Online_evaluation\How_participants_follow_class_comment_template.xlsx)
        Results for distribution of how participants follow the class comment template.
    - [What_participants_look_for_in_comments.xlsx](thesis\RP-Automatic-comment-generation\Dataset\Online_evaluation\What_participants_look_for_in_comments.xlsx)
        Results of evaluation for what participants look for in class comments.
    - [What_participants_write_in_comments.xlsx](thesis\RP-Automatic-comment-generation\Dataset\Online_evaluation\What_participants_write_in_comments.xlsx)
        Results of evaluation for what participants write in class comments.

## Results/
- #### SI-Approach/
    Contains all the data for the results related to SI-Approach and the scripts used to generate said data.
    - [Class_stereotype_distribution.xlsx](thesis\RP-Automatic-comment-generation\Results\RQ2\Class_stereotype_distribution.xlsx)
    Extracted class stereotypes for 350 random classes in the Pharo base image. Evaluated in 10 classes per step.
    - [Class_stereotype_script.txt](thesis\RP-Automatic-comment-generation\Results\RQ2\Class_stereotype_script.txt)
    Script used in the Playground of Pharo to return counts of how many classes get assigned the specific class stereotypes. Returns numbers for the class stereotypes in alphabetical order. Boundary => Small
    - [Method_stereotype_dstribution.xlsx](thesis\RP-Automatic-comment-generation\Results\RQ2\Method_stereotype_distribution.xlsx)
    Extracted method stereotypes for 500 random classes in the Pharo base image. Evaluated in 20 classes per step.
    - [Method_stereotype_script.txt](thesis\RP-Automatic-comment-generation\Results\RQ2\Method_stereotype_script.txt)
    Script used in the Playground of Pharo to return counts of how many methods get assigned the specific method stereotypes. Returns numbers for the method stereotypes in the order Accessors, Getters, Mutators, Setters, Collaborators, Controllers, Factories and Degenerate.