Skip to content

Latest commit

 

History

History
56 lines (27 loc) · 2.57 KB

README.md

File metadata and controls

56 lines (27 loc) · 2.57 KB
Raw

Archived version on archiving repository (Zenodo)

https://zenodo.org/badge/latestdoi/373793704

DOI

What is smartExpander?

smartExpander is a tool for suggesting whether abbreviations are used properly, i.e., whether they should be replaced with corresponding full terms.

What is included by this Github repository?

/MCParser: The Java implementation of smartExpander.

testDataAndCommand.csv: Testing data to replicate the evaluation in the paper

How to use smartExpander as a reusable and independent tool?

1. Download the implementation and testing data:

git clone [email protected]:jiangyanjie/smartExpander.git

2. Switch to the folder where .class files are:

  cd Path2Github\smartExpander\MCParser\out\production\MCParser

where Path2Github refers to the folder where smartExpander is located.

3. Test smartExpander with a single abbreviation:

 java FindCasualNames.main.smartExpander `abbr` `identifier` `contexts` `typeOfIdentifer` `expansion` `projectName`

where abbr is the abbreviation to be tested; identifier is the identifer containing the abbreviation; contexts is the contexts of the abbreviations (i.e., identifiers sourrounding the abbreviations; typeOfIdentifer is the type of the enclosing identifier (e.g., variable name or method name); expansion is the full terms of the abbreviation; projectName is the name of the enclosing Java project.

As an illustrating example, you may execute the following Java common and receive the output "True":

  java FindCasualNames.main.smartExpander nf nf file#jsmooth#model#persistency#make#path#relative#if#possible#root variableName new file davmail

4. Expected Output for the execution:

 “True”: if the abbreviation should be expanded

 “False”: if the abbreviation should not be expanded

How to replicate the evaluation?

1. Open testDataAndCommand.csv

Each row of the table  (except for the first row) represents a testing item (abbreviations).

2. To test the abbreviation on the ith row, copy the testing command on the last row "Java Command 2 Test This Item", execute the commond (referring to the section "How to use smartExpander as a reusable and independent tool?"), and check the results against the value on row "Necessity4Expansion(Prediction)"

image