Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
bl_vcf_skip_header(3)	   Library Functions Manual	 bl_vcf_skip_header(3)

NAME
       bl_vcf_skip_header() - Read past	VCF header

LIBRARY
       #include	<biolibc/vcf.h>
       -lbiolibc -lxtend

SYNOPSIS
       FILE    *bl_vcf_skip_header(FILE	*vcf_stream)

ARGUMENTS
       vcf_stream  FILE	pointer	of VCF stream to be read

DESCRIPTION
       Skip  over meta-data lines and header line (beginning with #CHROM) in a
       VCF input stream, leaving the FILE  structure  pointing	to  the	 first
       character  in the first line of data.  The skipped meta-data and	header
       are copied to a temporary file whose FILE pointer is returned.

       Note that the header line (beginning with #CHROM	and containing	sample
       IDs)  is	typically read using bl_vcf_get_sample_ids(3).	If you wish to
       do this,	call bl_vcf_skip_meta_data() instead of	bl_vcf_skip_header().

RETURN VALUES
       BL_READ_OK upon success,	BL_READ_TRUNCATED if read fails

SEE ALSO
       bl_vcf_get_sample_ids(3),		 bl_vcf_read_static_fields(3),
       bl_vcf_read_ss_call(3)

							 bl_vcf_skip_header(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=bl_vcf_skip_header&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help