RCPGenerator: RCPGenerator calculates RCP, Relative Control Percentile, a...

Description Usage Arguments

View source: R/RCPGenerator.R

Description

RCPGenerator calculates RCP, Relative Control Percentile, a case-control statistic describing the percentile from 0.0 to 1.0 of one score against that of a control population. For example, if a control population consisted of three scores, 4.1, 5.0, 6.8, and 10.1, then a score of 5.0 would be assigned an RCP of 0.25, because 5.0 is higher than 25 population. In this implementation, ties count as losses.

Usage

1
2
RCPGenerator(case, ctrl, min_hits = 0, hit_thresh = 0,
  verbose = FALSE)

Arguments

case

Data frame of cases.

ctrl

Data frame of controls.

min_hits

Numeric, hreshold for number of cases scoring above hit_thresh in original score required to be retained after filtering. By default, min_hits is set to 0 and thus RCP is calculated for all peptides. Setting a nonzero value for min_hits is only recommended if calculating RCP for all peptides is prohibitively slow.

hit_thresh

Vector of numeric, threshold value to apply when considering min_hits. hit_thresh is only evaluated if min_hits > 0.

verbose

Logical to print status updates to console.


brandonsie/phipcc documentation built on June 2, 2020, 6:19 a.m.