CodingAnnotationStudy (DKPro Statistics 2.2.0-SNAPSHOT API)

java.lang.Object
- org.dkpro.statistics.agreement.AnnotationStudy
- - org.dkpro.statistics.agreement.coding.CodingAnnotationStudy

All Implemented Interfaces:

Cloneable, ICodingAnnotationStudy, IAnnotationStudy
```
public class CodingAnnotationStudy
extends AnnotationStudy
implements ICodingAnnotationStudy, Cloneable
```
Default implementation of the ICodingAnnotationStudy interface. Instantiate this class for representing the annotation item of a coding study (i.e., an annotation setup in which the (human) raters are asked to code a set of given annotation items). The standard way of representing the annotation units (i.e., the category assigned by a certain rater) of an annotation item is using the addItem(Object...) method which allows specifying the list of categories assigned by the raters.

Author:

Christian M. Meyer

See Also:

ICodingAnnotationStudy, ICodingAnnotationItem

Field Summary

Fields
Modifier and Type Field and Description

protected List<ICodingAnnotationItem> items
- Fields inherited from class org.dkpro.statistics.agreement.AnnotationStudy
  categories, raters

Fields
Modifier and Type	Field and Description
`protected List<ICodingAnnotationItem>`	`items`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`CodingAnnotationStudy()` Initializes and empty annotation study for a coding task.
	`CodingAnnotationStudy(int raterCount)` Initializes and empty annotation study for a coding task with the given number of raters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addItem(ICodingAnnotationItem item)` Add the given annotation item to this study.
`ICodingAnnotationItem`	`addItem(Object... annotations)` Creates a new `CodingAnnotationItem` which has been coded with the given annotation categories.
`ICodingAnnotationItem`	`addItemAsArray(Object[] annotations)` Creates a new `CodingAnnotationItem` which has been coded with the given annotation categories.
`void`	`addMultipleItems(int times, Object... values)` Shorthand for invoking `addItem(Object...)` with the same parameters multiple times.
`CodingAnnotationStudy`	`clone()`
`static Map<Object,int[]>`	`countAnnotationsPerCategory(ICodingAnnotationStudy study)` Returns a two-dimensional map of categories and raters and the corresponding usage frequencies in the given annotation study (i.e., how often a certain rater used a certain category for coding an annotation unit).
`static Map<Object,Map<Object,Double>>`	`countCategoryCoincidence(ICodingAnnotationItem item)` Returns a two dimensional map of category pairs and their co-occurrence frequencies for the given annotation item.
`static Map<Object,Map<Object,Double>>`	`countCategoryCoincidence(ICodingAnnotationStudy study)` Returns a two dimensional map of category pairs and their co-occurrence frequencies for the given annotation study.
`static Map<Object,Integer>`	`countTotalAnnotationsPerCategory(ICodingAnnotationItem item)` Returns a map of categories and their usage frequencies (i.e., how often they are used in annotation units) within the given annotation item.
`static Map<Object,Integer>`	`countTotalAnnotationsPerCategory(ICodingAnnotationStudy study)` Returns a map of categories and their usage frequencies (i.e., how often they are used in annotation units) within the given annotation study.
`protected IAnnotationUnit`	`createUnit(int index, int raterIdx, Object category)`
`CodingAnnotationStudy`	`extractRaters(int... raters)` Returns a clone of the current annotation study which contains only the annotation units of the raters with the given indexes.
`ICodingAnnotationItem`	`getItem(int index)` Returns the annotation item with the given index.
`int`	`getItemCount()` Returns the number of annotation items defined by the study.
`Iterable<ICodingAnnotationItem>`	`getItems()` Allows iterating all annotation items of this study.
`int`	`getUnitCount()` Returns the number of annotation units defined by the study.
`boolean`	`hasMissingValues()` Returns true if, and only if, the annotation study contains at least one item with a missing value (i.e., an annotation item containing an annotation unit with category null).
`CodingAnnotationStudy`	`stripCategories(Object keepCategory, Object nullCategory)` Returns a clone of the current annotation study in which all categories are replaced by the given nullCategory except the categories matching the specified keepCategory.

Methods inherited from class org.dkpro.statistics.agreement.AnnotationStudy
addCategory, addRater, findRater, getCategories, getCategoryCount, getRaterCount, isDichotomous

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.dkpro.statistics.agreement.IAnnotationStudy
getCategories, getCategoryCount, getRaterCount, isDichotomous

- Field Detail
  - items
```
protected List<ICodingAnnotationItem> items
```
- Constructor Detail
  - CodingAnnotationStudy
```
protected CodingAnnotationStudy()
```
    Initializes and empty annotation study for a coding task. The basic setup of a coding study is assigning categories to units with fixed boundaries.
  - CodingAnnotationStudy
```
public CodingAnnotationStudy(int raterCount)
```
    Initializes and empty annotation study for a coding task with the given number of raters. The basic setup of a coding study is assigning categories to units with fixed boundaries.
- Method Detail
  - addItem
```
protected void addItem(ICodingAnnotationItem item)
```
    Add the given annotation item to this study. The specified item should never be null. When relying on the default implementation CodingAnnotationItem, it is recommended to use addItem(Object...) instead.
  - addItem
```
public ICodingAnnotationItem addItem(Object... annotations)
```
    Creates a new CodingAnnotationItem which has been coded with the given annotation categories. Note that the order of the categories must correspond to the raters' indexes. Use null to represent missing annotations, Invoking addItem("A", "B", null, "A") indicates an annotation item which has been coded as category "A" by rater 0 and 3 and as category "B" by rater 1. Rater 2 did not assign any category to the item. The method is a shorthand for addItemAsArray(Object[]).
    
    Throws:
    
    IllegalArgumentException - if the number of annotations does not match the number of raters.
  - addItemAsArray
```
public ICodingAnnotationItem addItemAsArray(Object[] annotations)
```
    Creates a new CodingAnnotationItem which has been coded with the given annotation categories. Note that the order of the categories must correspond to the raters' indexes. Use null to represent missing annotations, Invoking addItem(new Object[]{"A", "B", null, "A"}) indicates an annotation item which has been coded as category "A" by rater 0 and 3 and as category "B" by rater 1. Rater 2 did not assign any category to the item.
    
    Throws:
    
    IllegalArgumentException - if the number of annotations does not match the number of raters.
  - addMultipleItems
```
public void addMultipleItems(int times,
                             Object... values)
```
    Shorthand for invoking addItem(Object...) with the same parameters multiple times. This method is useful for modeling annotation data based on a contingency table.
  - createUnit
```
protected IAnnotationUnit createUnit(int index,
                                     int raterIdx,
                                     Object category)
```
  - getItem
```
public ICodingAnnotationItem getItem(int index)
```
    Description copied from interface: ICodingAnnotationStudy
    
    Returns the annotation item with the given index. The first item has index 0.
    
    Specified by:
    
    getItem in interface ICodingAnnotationStudy
  - getItems
```
public Iterable<ICodingAnnotationItem> getItems()
```
    Description copied from interface: ICodingAnnotationStudy
    
    Allows iterating all annotation items of this study.
    
    Specified by:
    
    getItems in interface ICodingAnnotationStudy
  - getItemCount
```
public int getItemCount()
```
    Description copied from interface: ICodingAnnotationStudy
    
    Returns the number of annotation items defined by the study.
    
    Specified by:
    
    getItemCount in interface ICodingAnnotationStudy
  - getUnitCount
```
public int getUnitCount()
```
    Description copied from interface: ICodingAnnotationStudy
    
    Returns the number of annotation units defined by the study. That is, the number of annotations coded by the raters. If there are no missing values, the unit count equals the item count multiplied with the number of raters.
    
    Specified by:
    
    getUnitCount in interface ICodingAnnotationStudy
    
    Specified by:
    
    getUnitCount in interface IAnnotationStudy
  - hasMissingValues
```
public boolean hasMissingValues()
```
    Description copied from interface: ICodingAnnotationStudy
    
    Returns true if, and only if, the annotation study contains at least one item with a missing value (i.e., an annotation item containing an annotation unit with category null).
    
    Specified by:
    
    hasMissingValues in interface ICodingAnnotationStudy
  - clone
```
public CodingAnnotationStudy clone()
```
    Overrides:
    
    clone in class Object
  - stripCategories
```
public CodingAnnotationStudy stripCategories(Object keepCategory,
                                             Object nullCategory)
```
    Returns a clone of the current annotation study in which all categories are replaced by the given nullCategory except the categories matching the specified keepCategory.
  - extractRaters
```
public CodingAnnotationStudy extractRaters(int... raters)
```
    Returns a clone of the current annotation study which contains only the annotation units of the raters with the given indexes. All other units will be removed. This method is useful for converting an annotation study with multiple raters into a (pairwise) annotation study with two raters.
  - countAnnotationsPerCategory
```
public static Map<Object,int[]> countAnnotationsPerCategory(ICodingAnnotationStudy study)
```
    Returns a two-dimensional map of categories and raters and the corresponding usage frequencies in the given annotation study (i.e., how often a certain rater used a certain category for coding an annotation unit).
  - countTotalAnnotationsPerCategory
```
public static Map<Object,Integer> countTotalAnnotationsPerCategory(ICodingAnnotationStudy study)
```
    Returns a map of categories and their usage frequencies (i.e., how often they are used in annotation units) within the given annotation study.
  - countTotalAnnotationsPerCategory
```
public static Map<Object,Integer> countTotalAnnotationsPerCategory(ICodingAnnotationItem item)
```
    Returns a map of categories and their usage frequencies (i.e., how often they are used in annotation units) within the given annotation item.
  - countCategoryCoincidence
```
public static Map<Object,Map<Object,Double>> countCategoryCoincidence(ICodingAnnotationStudy study)
```
    Returns a two dimensional map of category pairs and their co-occurrence frequencies for the given annotation study.
  - countCategoryCoincidence
```
public static Map<Object,Map<Object,Double>> countCategoryCoincidence(ICodingAnnotationItem item)
```
    Returns a two dimensional map of category pairs and their co-occurrence frequencies for the given annotation item.

Class CodingAnnotationStudy

Field Summary

Fields inherited from class org.dkpro.statistics.agreement.AnnotationStudy

Constructor Summary

Method Summary

Methods inherited from class org.dkpro.statistics.agreement.AnnotationStudy

Methods inherited from class java.lang.Object

Methods inherited from interface org.dkpro.statistics.agreement.IAnnotationStudy

Field Detail

items

Constructor Detail

CodingAnnotationStudy

CodingAnnotationStudy

Method Detail

addItem

addItem

addItemAsArray

addMultipleItems

createUnit

getItem

getItems

getItemCount

getUnitCount

hasMissingValues

clone

stripCategories

extractRaters

countAnnotationsPerCategory

countTotalAnnotationsPerCategory

countTotalAnnotationsPerCategory

countCategoryCoincidence

countCategoryCoincidence