Newer
Older
/*
* This file is part of Artemis
*
* Copyright (C) 2013 Genome Research Limited
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
*/
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
package uk.ac.sanger.artemis.io;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import java.io.IOException;
import java.net.URL;
import java.util.LinkedHashMap;
import java.util.Map;
import org.apache.log4j.Level;
import org.junit.Test;
import junit.framework.Assert;
import uk.ac.sanger.artemis.EntryGroup;
import uk.ac.sanger.artemis.Options;
import uk.ac.sanger.artemis.SimpleEntryGroup;
import uk.ac.sanger.artemis.components.EntryFileDialog;
import uk.ac.sanger.artemis.components.genebuilder.GeneUtils;
import uk.ac.sanger.artemis.io.DocumentEntryFactory;
import uk.ac.sanger.artemis.io.Entry;
import uk.ac.sanger.artemis.io.EntryInformationException;
import uk.ac.sanger.artemis.io.FeatureVector;
import uk.ac.sanger.artemis.io.GFFStreamFeature;
import uk.ac.sanger.artemis.io.ValidateFeature;
import uk.ac.sanger.artemis.util.Document;
import uk.ac.sanger.artemis.util.DocumentFactory;
import uk.ac.sanger.artemis.util.OutOfRangeException;
import uk.ac.sanger.artemis.sequence.NoSequenceException;
public class ValidateFeatureTest
{
@Test
public void testGFF()
{
try
{
final Entry entry = Utils.getEntry("/data/test.gff.gz");
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
final EntryGroup egrp = new SimpleEntryGroup();
egrp.add(new uk.ac.sanger.artemis.Entry(entry));
ValidateFeature validate = new ValidateFeature(egrp);
final FeatureVector features = entry.getAllFeatures();
for(uk.ac.sanger.artemis.io.Feature f: features)
{
if(ValidateFeature.isGFF(f, null))
{
GFFStreamFeature gffFeature = (GFFStreamFeature)f;
String id = GeneUtils.getUniqueName(gffFeature);
assertTrue("Boundary "+id, ValidateFeature.isBoundaryOK(gffFeature) == 0);
assertTrue("Strand "+id, ValidateFeature.isStrandOK(gffFeature));
assertTrue("CDS phase "+id, ValidateFeature.isCDSPhaseOK(gffFeature));
assertTrue("Attribute "+id, ValidateFeature.isAttributesOK(gffFeature).length() == 0);
assertTrue("ID check "+id, ValidateFeature.isIdPrefixConsistent(gffFeature));
assertTrue("Start_range check "+id, ValidateFeature.isPartialConsistent(gffFeature, "Start_range"));
assertTrue("End_range check "+id, ValidateFeature.isPartialConsistent(gffFeature, "End_range"));
if(ValidateFeature.isPartOfGene(gffFeature))
assertTrue("Gene model "+id, ValidateFeature.isCompleteGeneModelOK(gffFeature) == 0);
}
assertTrue("Stop codon", validate.hasValidStop(f));
assertTrue("Internal stop codon", !validate.isInternalStops(f));
}
}
catch(OutOfRangeException e)
{
Assert.fail(e.getMessage());
}
catch(NoSequenceException e)
{
Assert.fail(e.getMessage());
}
}
/**
* Test the gene model boundary is consistent
*/
@Test
public void testGFFBoundary()
{
final Entry entry = Utils.getEntry("/data/test_boundary.gff.gz");
final FeatureVector features = entry.getAllFeatures();
for(uk.ac.sanger.artemis.io.Feature f: features)
{
if(ValidateFeature.isGFF(f, null))
{
GFFStreamFeature gffFeature = (GFFStreamFeature)f;
String id = GeneUtils.getUniqueName(gffFeature);
if(id.equals("PF3D7_0200100"))
assertTrue("Boundary check: "+id, ValidateFeature.isBoundaryOK(gffFeature) != 0); // boundary not OK
else
assertTrue("Boundary check: "+id, ValidateFeature.isBoundaryOK(gffFeature) == 0); // boundary OK
}
}
}
/**
* Test the gene model strand is consistent
*/
@Test
public void testGFFStrand()
{
final Entry entry = Utils.getEntry("/data/test_boundary.gff.gz");
final FeatureVector features = entry.getAllFeatures();
for(uk.ac.sanger.artemis.io.Feature f: features)
{
if(ValidateFeature.isGFF(f, null))
{
GFFStreamFeature gffFeature = (GFFStreamFeature)f;
String id = GeneUtils.getUniqueName(gffFeature);
if(id.equals("PF3D7_0200300"))
assertTrue("Strand check: "+id, !ValidateFeature.isStrandOK(gffFeature)); // strand not ok
else
assertTrue("Strand check: "+id, ValidateFeature.isStrandOK(gffFeature)); // strand ok
}
}
}
/**
* Test the CDS has a phase
*/
@Test
public void testGFFPhase()
{
final Entry entry = Utils.getEntry("/data/test_boundary.gff.gz");
final FeatureVector features = entry.getAllFeatures();
for(uk.ac.sanger.artemis.io.Feature f: features)
{
if(ValidateFeature.isGFF(f, null))
{
GFFStreamFeature gffFeature = (GFFStreamFeature)f;
String id = GeneUtils.getUniqueName(gffFeature);
if(id.equals("PF3D7_0200200.1:exon{2,1}"))
assertTrue("CDS phase check: "+id, !ValidateFeature.isCDSPhaseOK(gffFeature)); // phase not ok
else
assertTrue("CDS phase check: "+id, ValidateFeature.isCDSPhaseOK(gffFeature)); // phase ok
}
}
}
/**
* Test the gene models are complete
*/
@Test
public void testGFFCompleteGeneModel()
{
final Entry entry = Utils.getEntry("/data/test_boundary.gff.gz");
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
final FeatureVector features = entry.getAllFeatures();
for(uk.ac.sanger.artemis.io.Feature f: features)
{
if(ValidateFeature.isGFF(f, null))
{
GFFStreamFeature gffFeature = (GFFStreamFeature)f;
if(ValidateFeature.isPartOfGene(gffFeature))
{
String id = GeneUtils.getUniqueName(gffFeature);
if(id.startsWith("PF3D7_0200500"))
assertTrue("Complete gene model check: "+id, // gene model missing mRNA
ValidateFeature.isCompleteGeneModelOK(gffFeature) != 0);
else
assertTrue("Complete gene model check: "+id, // gene model complete
ValidateFeature.isCompleteGeneModelOK(gffFeature) == 0);
}
}
}
}
/**
* Test if the ID GFF3 attribute prefix is consistent within a gene model
*/
@Test
public void testGFFId()
{
final Entry entry = Utils.getEntry("/data/test_boundary.gff.gz");
final FeatureVector features = entry.getAllFeatures();
for(uk.ac.sanger.artemis.io.Feature f: features)
{
if(ValidateFeature.isGFF(f, null))
{
GFFStreamFeature gffFeature = (GFFStreamFeature)f;
if(ValidateFeature.isPartOfGene(gffFeature))
{
String id = GeneUtils.getUniqueName(gffFeature);
assertTrue("Complete gene model check: "+id,
ValidateFeature.isIdPrefixConsistent(gffFeature));
}
}
}
}
/**
* Test if the Start_range and End_range are constistent within a gene model
*/
@Test
public void testGFFPartials()
{
final Entry entry = Utils.getEntry("/data/test_boundary.gff.gz");
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
final FeatureVector features = entry.getAllFeatures();
for(uk.ac.sanger.artemis.io.Feature f: features)
{
if(ValidateFeature.isGFF(f, null))
{
GFFStreamFeature gffFeature = (GFFStreamFeature)f;
if(ValidateFeature.isPartOfGene(gffFeature))
{
String id = GeneUtils.getUniqueName(gffFeature);
assertTrue("Start_range check: "+id,
ValidateFeature.isPartialConsistent(gffFeature, "Start_range"));
assertTrue("End_range check: "+id,
ValidateFeature.isPartialConsistent(gffFeature, "End_range"));
}
}
}
}
/**
* Test if the Start_range and End_range are constistent within a gene model
*/
@Test
public void testGFFAttributes()
{
final Entry entry = Utils.getEntry("/data/test_boundary.gff.gz");
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
final FeatureVector features = entry.getAllFeatures();
for(uk.ac.sanger.artemis.io.Feature f: features)
{
if(ValidateFeature.isGFF(f, null))
{
GFFStreamFeature gffFeature = (GFFStreamFeature)f;
if(ValidateFeature.isPartOfGene(gffFeature))
{
String id = GeneUtils.getUniqueName(gffFeature);
assertTrue("Attributes : "+id,
ValidateFeature.isAttributesOK(gffFeature).length() == 0);
}
}
}
}
/**
* Test stop codons for genes
*/
@Test
public void testGFFValidStop()
{
try
{
final Entry entry = Utils.getEntry("/data/test_boundary.gff.gz");
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
final FeatureVector features = entry.getAllFeatures();
final EntryGroup egrp = new SimpleEntryGroup();
egrp.add(new uk.ac.sanger.artemis.Entry(entry));
ValidateFeature validate = new ValidateFeature(egrp);
for (uk.ac.sanger.artemis.io.Feature f : features)
{
GFFStreamFeature gffFeature = (GFFStreamFeature)f;
String id = GeneUtils.getUniqueName(gffFeature);
if( (id.startsWith("PF3D7_0200100") || id.startsWith("PF3D7_0200500.1:exon:2")) &&
f.getKey().getKeyString().equals("CDS"))
assertTrue("Stop codon "+id, !validate.hasValidStop(f)); // not valid
else
assertTrue("Stop codon "+id, validate.hasValidStop(f));
}
}
catch (OutOfRangeException e)
{
Assert.fail(e.getMessage());
}
catch (NoSequenceException e)
{
Assert.fail(e.getMessage());
}
}
/**
* Test for internal stop codons
*/
@Test
public void testGFFInternalStop()
{
try
{
final Entry entry = Utils.getEntry("/data/test_boundary.gff.gz");
final FeatureVector features = entry.getAllFeatures();
final EntryGroup egrp = new SimpleEntryGroup();
egrp.add(new uk.ac.sanger.artemis.Entry(entry));
ValidateFeature validate = new ValidateFeature(egrp);
for (uk.ac.sanger.artemis.io.Feature f : features)
{
GFFStreamFeature gffFeature = (GFFStreamFeature)f;
String id = GeneUtils.getUniqueName(gffFeature);
assertTrue("Internal stop codon "+id, !validate.isInternalStops(f));
}
}
catch (OutOfRangeException e)
{
Assert.fail(e.getMessage());
}
catch (NoSequenceException e)
{
Assert.fail(e.getMessage());
}
}
}