Debian Codegraph @

src/java/org/broadinstitute/dropseqrna/barnyard/digitalallelecounts/sampleassignment/BestSampleAssignmentForCell.java

raw
1 /*
2 * MIT License
3 *
4 * Copyright 2017 Broad Institute
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in all
14 * copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 */
24 package org.broadinstitute.dropseqrna.barnyard.digitalallelecounts.sampleassignment;
25
26 /**
27 * Simple container to hold the best sample assignment for a cell out of all possible assignments.
28 * @author nemesh
29 *
30 */
31 public class BestSampleAssignmentForCell {
32
33 private final String cellBarcode;
34 private final String sample;
35 private final double bestLoglikelihood;
36 private final double secondBestLogLikelihood;
37 private final double oneMinusPvalue;
38
39 public BestSampleAssignmentForCell (final String cellBarcode, final String sample, final double bestLogLikelihood, final double secondBestLogLikelihood, final double oneMinusPvalue) {
40 this.cellBarcode=cellBarcode;
41 this.sample=sample;
42 this.bestLoglikelihood=bestLogLikelihood;
43 this.secondBestLogLikelihood=secondBestLogLikelihood;
44 this.oneMinusPvalue=oneMinusPvalue;
45 }
46
47 public String getSample () {
48 return this.sample;
49 }
50
51 public String getCellBarcode() {
52 return cellBarcode;
53 }
54
55 /**
56 * Returns the best-secondBest loglikelihood
57 * @return
58 */
59 public double getLogLikelihoodRatio () {
60 return this.bestLoglikelihood-this.secondBestLogLikelihood;
61 }
62
63 public double getBestLoglikelihood () {
64 return this.bestLoglikelihood;
65 }
66
67 public double getOneMinusPvalue() {
68 return oneMinusPvalue;
69 }
70
71
72 }