Last data update: 2014.03.03

R: Total-Intra Ratio (TIR)
TIRR Documentation

Total-Intra Ratio (TIR)

Description

Total-Intra Ratio (TIR) is the ratio of MSD(total) and MSD(intra), it compares the total-rater agreement to intra-rater precision.

Usage

TIR(data, k, m, testindex, refindex, error, alpha = 0.05)

Arguments

data

Name of your dataset.

k

Number of methods/raters/instruments/assay, etc.

m

Number of replications for each methods/raters/instruments/assay, etc.

testindex

The index for the test raters, it can be a numerical vector or a character value "all". For example, if testindex=c(1,2), the first and second rater are selected as the test raters for calculating TIR.

refindex

The index for the reference raters, it can be a numerical vector or a character value "all". For example, if refindex="all", all raters are selected as the reference raters for calculating TIR.

error

error="const" for the constant error structure for continuous data. error="prop" for the proportional error structure for continuous data. Here, log transformation to data will be applied for the continuous data. For categorical data, use error="const".

alpha

100(1-alpha)

Value

Return a list of values

TIR

The estimator of TIR.

TIR_upper

The upper 1-alpha confidence limit for TIR.

TIR_lower

The lower 1-alpha confidence limit for TIR.

Author(s)

Yue Yu <yyu@imyy.net>

See Also

TIR_IIR, IIR

Examples

data(DCLHb);
TIR(DCLHb, k=2,m=2,testindex=c(1,2),refindex="all",error="const",alpha=0.05);

Results


R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(Agreement)
Loading required package: R2HTML
> png(filename="/home/ddbj/snapshot/RGM3/R_CC/result/Agreement/TIR.Rd_%03d_medium.png", width=480, height=480)
> ### Name: TIR
> ### Title: Total-Intra Ratio (TIR)
> ### Aliases: TIR
> 
> ### ** Examples
> 
> data(DCLHb);
> TIR(DCLHb, k=2,m=2,testindex=c(1,2),refindex="all",error="const",alpha=0.05);
$TIR
[1] 10.09394

$TIR_upper
         [,1]
[1,] 13.65735

$TIR_lower
         [,1]
[1,] 7.460285

> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>