1   /*
2    * The baseCode project
3    *
4    * Copyright (c) 2010 University of British Columbia
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *       http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   *
18   */
19  package ubic.basecode.math.linearmodels;
20  
21  import java.util.Collection;
22  
23  public interface GenericAnovaResult extends AnovaResult {
24  
25      Collection<String> getMainEffectFactorNames();
26  
27      double getMainEffectDof( String factorName );
28  
29      double getMainEffectFStat( String factorName );
30  
31      double getMainEffectPValue( String factorName );
32  
33      boolean hasInteractions();
34  
35      /**
36       * Obtain the degrees of freedom for the interaction effects, if any.
37       * @throws IllegalStateException if there is more than one interaction effect
38       */
39      double getInteractionEffectDof();
40  
41      /**
42       * Obtain the F statistic for the interaction effects, if any.
43       * @throws IllegalStateException if there is more than one interaction effect
44       */
45      double getInteractionEffectFStat();
46  
47      /**
48       * Obtain the p-value for the interaction effects, if any.
49       * @throws IllegalStateException if there is more than one interaction effect
50       */
51      double getInteractionEffectPValue();
52  
53      /**
54       * Obtain all the combinations of factor names that have interaction effects.
55       */
56      Collection<String[]> getInteractionEffectFactorNames();
57  
58      double getInteractionEffectDof( String... factorNames );
59  
60      double getInteractionEffectFStat( String... factorNames );
61  
62      double getInteractionEffectPValue( String... factorNames );
63  }