@@ -14,7 +14,7 @@ knitr::opts_chunk$set(comment = NA, purl = FALSE, dpi = 96, fig.width = 0.5, fig
1414```
1515
1616``` {r render-how-to, include = FALSE, eval = FALSE, echo = FALSE}
17- # Render vignette outside of build_vignettes() via rmardown :
17+ # Render vignette outside of build_vignettes() via rmarkdown :
1818# Render the HTML vignette
1919rmarkdown::render('vignettes/UserGuide.Rmd', output_format = 'rmarkdown::html_vignette')
2020
@@ -85,6 +85,9 @@ vcf.data <- import.vcf(
8585str(vcf.data)
8686```
8787
88+
89+ #### Imported VCF data structures
90+
8891As we can see, ` import.vcf ` returns a list with two elements: ` split.wide.vcf.matrices ` and ` combined.long.vcf.df ` .
8992These two objects represent two ways of representing the imported data.
9093
@@ -93,7 +96,7 @@ It splits the VCF data into two objects: a table of per-variant data with only e
9396and a matrix of genotypes where each row corresponds to a variant and each column corresponds to an individual.
9497This format allows for efficient storage and manipulation of genotype data, especially for large VCF files.
9598The key limitation of this format is that it does not allow the importation of information (other than genotype)
96- unique to a sample-variant pair, such as that stored in the ` FORMAT ` field of the VCF file.
99+ unique to a sample-variant pair, such as that stored in the ` FORMAT ` field of the VCF file.
97100
98101
99102The "long" format is optional and will only be returned if ` long.format = TRUE ` is specified. It allows for the importation of all
@@ -183,10 +186,10 @@ head(pgs.bed.format)
183186```
184187
185188Coordinate files must match the coordinate style used in the VCF file you wish to filter. The ` convert.pgs.to.bed ` function provides options for
186- formatting chromosome names, as these tend to vary between human genome reference GRCh38 and GRCh37 aligned files .
189+ formatting chromosome names, as these can vary between human genome reference files that originate from different databases .
187190
188- - Use ` chr.prefix = TRUE ` to add 'chr' to the chromosome name (GRCh38 style)
189- - Use ` chr.prefix = FALSE ` to remove 'chr' from the chromosome name (GRCh37 style)
191+ - Use ` chr.prefix = TRUE ` to add 'chr' to the chromosome name (UCSC style)
192+ - Use ` chr.prefix = FALSE ` to remove 'chr' from the chromosome name (Ensembl style)
190193- Use ` numeric.sex.chr = FALSE ` to format the X and Y chromosomes as 'X' and 'Y' respectively
191194- Use ` numeric.sex.chr = TRUE ` to format the X and Y chromosomes as '23' and '24' respectively
192195
0 commit comments