1\" Generated by c2man from bl_bed_gff_cmp.c
2.TH bl_bed_gff_cmp 3
3
4.SH LIBRARY
5\" Indicate #includes, library name, -L and -l flags
6.nf
7.na
8#include <biolibc/bed.h>
9-lbiolibc -lxtend
10.ad
11.fi
12
13\" Convention:
14\" Underline anything that is typed verbatim - commands, etc.
15.SH SYNOPSIS
16.PP
17int     bl_bed_gff_cmp(bl_bed_t *bed_feature, bl_gff_t *gff_feature,
18bl_overlap_t *overlap)
19
20.SH ARGUMENTS
21.nf
22.na
23bed_feature     Pointer to the bl_bed_t structure to compare
24gff_feature     Pointer to the bl_gff_t structure to compare
25overlap         Pointer to the bl_overlap_t structure to receive
26comparison results
27.ad
28.fi
29
30.SH DESCRIPTION
31
32Compare the position of a BED feature to that of a GFF feature.
33Return 0 if the features overlap, < 0 if the BED feature is upstream
34of the GFF feature, > 0 if the BED feature is downstream of the GFF
35feature.
36
37If the features overlap, populate the bl_overlap_t structure
38pointed to by overlap.  The structure contains the lengths of the
39two features, the start and end positions of the overlapping region,
40and the length of the overlap.  Positions in overlap are 1-based and
41inclusive at both ends (like most bioinformatics formats and unlike
42BED).
43
44.SH RETURN VALUES
45
46A value < 0 if the BED feature is upstream of the GFF feature
47A value > 0 if the BED feature is downstream of the GFF feature
480 if the BED feature overlaps the GFF feature
49
50.SH EXAMPLES
51.nf
52.na
53
54if ( bl_bed_gff_cmp(&bed_feature, &gff_feature, *overlap) == 0 )
55.ad
56.fi
57
58.SH SEE ALSO
59
60bl_bed_read(3), bl_gff_read(3)
61
62