Package org.dkpro.statistics.agreement.coding

Class PercentageAgreement

java.lang.Object

org.dkpro.statistics.agreement.AgreementMeasure

org.dkpro.statistics.agreement.coding.CodingAgreementMeasure

org.dkpro.statistics.agreement.coding.PercentageAgreement

All Implemented Interfaces:

ICodingAgreementMeasure, ICodingItemSpecificAgreement, IAgreementMeasure, ICategorySpecificAgreement, IItemSpecificAgreement<ICodingAnnotationItem>

public class PercentageAgreement
extends CodingAgreementMeasure
implements ICodingItemSpecificAgreement, ICategorySpecificAgreement

Implementation of a simple percentage of agreement measure for calculating the inter-rater agreement for two or more raters. The measure is neither chance-corrected nor weighted.

References:

• Artstein, R. & Poesio, M.: Inter-Coder Agreement for Computational Linguistics. Computational Linguistics 34(4):555-596, 2008.

Author:

Christian M. Meyer

Field Summary

Fields inherited from class org.dkpro.statistics.agreement.coding.CodingAgreementMeasure

study

Constructor Summary

Constructors

Constructor	Description
PercentageAgreement(ICodingAnnotationStudy study)	Initializes the instance for the given annotation study.

Method Summary

Modifier and Type	Method	Description
double	calculateCategoryAgreement(java.lang.Object category)	Calculates the inter-rater agreement for the given annotation category based on the object's annotation study that has been passed to the class constructor.
double	calculateItemAgreement(ICodingAnnotationItem item)	Calculates the inter-rater agreement for the given annotation item.

Methods inherited from class org.dkpro.statistics.agreement.coding.CodingAgreementMeasure

calculateObservedAgreement, doCalculateItemAgreement, ensureTwoRaters, warnIfMissingValues

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

calculateAgreement, calculateExpectedAgreement

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

calculateAgreement

Constructor Details

PercentageAgreement

public PercentageAgreement(ICodingAnnotationStudy study)

Initializes the instance for the given annotation study. The study should never be null.

Method Details

calculateItemAgreement

public double calculateItemAgreement(ICodingAnnotationItem item)

Calculates the inter-rater agreement for the given annotation item. This is the basic step that is performed for each item of an annotation study, when calling AgreementMeasure.calculateAgreement().

Specified by:

calculateItemAgreement in interface IItemSpecificAgreement<ICodingAnnotationItem>

Throws:

java.lang.NullPointerException - if the given item is null.

See Also:

IItemSpecificAgreement

calculateCategoryAgreement

public double calculateCategoryAgreement(java.lang.Object category)

Calculates the inter-rater agreement for the given annotation category based on the object's annotation study that has been passed to the class constructor.

Specified by:

calculateCategoryAgreement in interface ICategorySpecificAgreement

Throws:

java.lang.NullPointerException - if the study is null or the given category is null.

java.lang.ArrayIndexOutOfBoundsException - if the study does not contain the given category.

java.lang.ArithmeticException - if the study does not contain annotations for the given category.

See Also:

ICategorySpecificAgreement