You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,7 +63,7 @@ Moreover, the results comprise the (LaTeX) tables that are part of our paper and
63
63
64
64
### Documentation
65
65
66
-
DiffDetective's code base is documented with javadoc and can be accessed on this [website][documentation]. Interesting classes of our library are:
66
+
DiffDetectiveis documented with javadoc. The documentation can be accessed on this [website][documentation]. Notable classes of our library are:
67
67
-[DiffTree](https://variantsync.github.io/DiffDetective/docs/javadoc/org/variantsync/diffdetective/diff/difftree/DiffTree.html) and [DiffNode](https://variantsync.github.io/DiffDetective/docs/javadoc/org/variantsync/diffdetective/diff/difftree/DiffNode.html) implement variation tree diffs from our paper. A variation tree diff is represented by an instance of the `DiffTree` class. It stores the root node of the diff and offers various methods to parse, traverse, and analyze variation tree diffs. `DiffNode`s represent individual nodes within a variation tree diff.
68
68
-[Validation](https://variantsync.github.io/DiffDetective/docs/javadoc/org/variantsync/diffdetective/validation/Validation.html) contains the main method for our validation.
69
69
-[ProposedElementaryPatterns](https://variantsync.github.io/DiffDetective/docs/javadoc/org/variantsync/diffdetective/pattern/elementary/proposed/ProposedElementaryPatterns.html) holds the catalog of nine edit patterns we proposed in our paper. It implements the interface [ElementaryPatternCatalogue](https://variantsync.github.io/DiffDetective/docs/javadoc/org/variantsync/diffdetective/pattern/elementary/ElementaryPatternCatalogue.html), which allows to define custom pattern catalogs.
@@ -76,7 +76,7 @@ DiffDetective's code base is documented with javadoc and can be accessed on this
76
76
Our [appendix][appendix] consists of:
77
77
1. An extended formalization of our concepts in the [Haskell][haskell] programming language. The corresponding source code is also part of this replication package (see below).
78
78
2. The proofs for (a) the completeness of variation tree diffs to represent edits to variation trees, and (b) the completeness and unambiguity of our elementary edit patterns.
79
-
3. An inspection of edit patterns from related work to show that existing patterns are either composite patterns built from our elementary patterns or similar to our elementary patterns.
79
+
3. An inspection of edit patterns from related work to show that existing patterns are either composite patterns built from our elementary patterns or similar to our elementary patterns. The used diffs of these patterns can also be found in [docs/compositepatterns](docs/compositepatterns).
80
80
4. The complete results of our validation for all 44 datasets.
81
81
82
82
## 3. Haskell Formalization
@@ -95,7 +95,7 @@ We provide updated links for each system's repository.
95
95
### 4.2 Forked Repositories for Replication
96
96
To guarantee the exact replication of our validation, we created forks of all 44 open-source repositories at the state we performed the validation for our paper.
97
97
The forked repositories are listed in the [replication datasets](docs/replication/datasets.md) and are located at the Github user profile [DiffDetective](https://github.com/DiffDetective?tab=repositories).
98
-
These repositories are used when running the replication as described under `1.2`.
98
+
These repositories are used when running the replication as described under `1.2` and in the [INSTALL](INSTALL.md).
99
99
100
100
## 5. Running DiffDetective on Custom Datasets
101
101
You can also run DiffDetective on other datasets by providing the path to the dataset file as first argument to the execution script:
@@ -107,14 +107,14 @@ You can also run DiffDetective on other datasets by providing the path to the da
107
107
108
108
The input file must have the same format as the other dataset files (i.e., repositories are listed in a Markdown table). You can find [dataset files](docs/datasets.md) in the [docs](docs) folder.
0 commit comments