An R/Bioconductor library to perform genomic liftover between different genome assemblies with GRanges and chain file. Source Code: https://github.com/nahid18/easylift
if (!require("BiocManager", quietly = TRUE))
install.packages("BiocManager")
BiocManager::install("easylift")To view documentation:
browseVignettes("easylift")library("easylift")
#> Loading required package: GenomicRanges
#> Loading required package: stats4
#> Loading required package: BiocGenerics
#>
#> Attaching package: 'BiocGenerics'
#> The following objects are masked from 'package:stats':
#>
#> IQR, mad, sd, var, xtabs
#> The following objects are masked from 'package:base':
#>
#> Filter, Find, Map, Position, Reduce, anyDuplicated, aperm, append,
#> as.data.frame, basename, cbind, colnames, dirname, do.call,
#> duplicated, eval, evalq, get, grep, grepl, intersect, is.unsorted,
#> lapply, mapply, match, mget, order, paste, pmax, pmax.int, pmin,
#> pmin.int, rank, rbind, rownames, sapply, saveRDS, setdiff, table,
#> tapply, union, unique, unsplit, which.max, which.min
#> Loading required package: S4Vectors
#>
#> Attaching package: 'S4Vectors'
#> The following object is masked from 'package:utils':
#>
#> findMatches
#> The following objects are masked from 'package:base':
#>
#> I, expand.grid, unname
#> Loading required package: IRanges
#> Loading required package: GenomeInfoDb
#> Loading required package: BiocFileCache
#> Loading required package: dbplyrCreate a GRanges object, assign a genome to it, and specify chain file
gr <- GRanges(
seqname = Rle(
c("chr1", "chr2"),
c(100000, 100000)
),
ranges = IRanges(
start = 1, end = 200000
)
)
# Here, "hg19" is the source genome
genome(gr) <- "hg19"
# Here, we use the `system.file()` function because the chain file is in the
# package (however if you need to point to any other file on your machine,
# just do 'chain <- "path/to/your/hg19ToHg38.over.chain.gz"'):
chain <- system.file("extdata", "hg19ToHg38.over.chain.gz", package = "easylift")
gr
#> GRanges object with 200000 ranges and 0 metadata columns:
#> seqnames ranges strand
#> <Rle> <IRanges> <Rle>
#> [1] chr1 1-200000 *
#> [2] chr1 1-200000 *
#> [3] chr1 1-200000 *
#> [4] chr1 1-200000 *
#> [5] chr1 1-200000 *
#> ... ... ... ...
#> [199996] chr2 1-200000 *
#> [199997] chr2 1-200000 *
#> [199998] chr2 1-200000 *
#> [199999] chr2 1-200000 *
#> [200000] chr2 1-200000 *
#> -------
#> seqinfo: 2 sequences from hg19 genome; no seqlengthsCall easylift with GRanges object, target genome and the chain file.
# Here, "hg38" is the target genome
easylift(gr, "hg38", chain)
#> GRanges object with 300000 ranges and 0 metadata columns:
#> seqnames ranges strand
#> <Rle> <IRanges> <Rle>
#> [1] chr1 10001-177376 *
#> [2] chr19 242824-242864 *
#> [3] chr1 10001-177376 *
#> [4] chr19 242824-242864 *
#> [5] chr1 10001-177376 *
#> ... ... ... ...
#> [299996] chr2 10001-200000 *
#> [299997] chr2 10001-200000 *
#> [299998] chr2 10001-200000 *
#> [299999] chr2 10001-200000 *
#> [300000] chr2 10001-200000 *
#> -------
#> seqinfo: 25 sequences (1 circular) from hg38 genomeTo use BiocFileCache for the chain file, add it to the cache:
chain_file <- "/path/to/your/hg19ToHg38.over.chain.gz"
bfc <- BiocFileCache()
# Add chain file to cache if already not available
if (nrow(bfcquery(bfc, basename(chain_file))) == 0)
bfcadd(bfc, chain_file)Then, use it in easylift:
easylift(gr, "hg38")
# or
gr |> easylift("hg38")To cite package easylift in publications use:
Al Nahid A, Pagès H, Love M (2023). easylift: An R package to perform genomic liftover. R package version 1.0.0, https://github.com/nahid18/easylift.
A BibTeX entry for LaTeX users is
@Manual{,
title = {easylift: An R package to perform genomic liftover},
author = {Abdullah Al Nahid, Hervé Pagès, Michael Love},
year = {2023},
note = {R package version 1.0.0},
url = {https://github.com/nahid18/easylift},
}Please note that the easylift was only made possible thanks to many other R and bioinformatics software authors, which are cited either in the vignettes and/or the paper(s) describing this package.
Please note that the easylift project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
sessionInfo()
#> R version 4.4.1 (2024-06-14)
#> Platform: x86_64-pc-linux-gnu
#> Running under: Ubuntu 24.04.1 LTS
#>
#> Matrix products: default
#> BLAS: /home/biocbuild/bbs-3.20-bioc/R/lib/libRblas.so
#> LAPACK: /usr/lib/x86_64-linux-gnu/lapack/liblapack.so.3.12.0
#>
#> locale:
#> [1] LC_CTYPE=en_US.UTF-8 LC_NUMERIC=C
#> [3] LC_TIME=en_GB LC_COLLATE=C
#> [5] LC_MONETARY=en_US.UTF-8 LC_MESSAGES=en_US.UTF-8
#> [7] LC_PAPER=en_US.UTF-8 LC_NAME=C
#> [9] LC_ADDRESS=C LC_TELEPHONE=C
#> [11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C
#>
#> time zone: America/New_York
#> tzcode source: system (glibc)
#>
#> attached base packages:
#> [1] stats4 stats graphics grDevices utils datasets methods
#> [8] base
#>
#> other attached packages:
#> [1] easylift_1.4.0 BiocFileCache_2.14.0 dbplyr_2.5.0
#> [4] GenomicRanges_1.58.0 GenomeInfoDb_1.42.0 IRanges_2.40.0
#> [7] S4Vectors_0.44.0 BiocGenerics_0.52.0 BiocStyle_2.34.0
#>
#> loaded via a namespace (and not attached):
#> [1] SummarizedExperiment_1.36.0 rjson_0.2.23
#> [3] xfun_0.48 bslib_0.8.0
#> [5] lattice_0.22-6 Biobase_2.66.0
#> [7] vctrs_0.6.5 tools_4.4.1
#> [9] bitops_1.0-9 generics_0.1.3
#> [11] parallel_4.4.1 curl_5.2.3
#> [13] tibble_3.2.1 fansi_1.0.6
#> [15] RSQLite_2.3.7 blob_1.2.4
#> [17] pkgconfig_2.0.3 R.oo_1.26.0
#> [19] Matrix_1.7-1 lifecycle_1.0.4
#> [21] GenomeInfoDbData_1.2.13 compiler_4.4.1
#> [23] Rsamtools_2.22.0 Biostrings_2.74.0
#> [25] codetools_0.2-20 htmltools_0.5.8.1
#> [27] sass_0.4.9 RCurl_1.98-1.16
#> [29] yaml_2.3.10 pillar_1.9.0
#> [31] crayon_1.5.3 jquerylib_0.1.4
#> [33] R.utils_2.12.3 BiocParallel_1.40.0
#> [35] DelayedArray_0.32.0 cachem_1.1.0
#> [37] abind_1.4-8 tidyselect_1.2.1
#> [39] digest_0.6.37 dplyr_1.1.4
#> [41] restfulr_0.0.15 bookdown_0.41
#> [43] grid_4.4.1 fastmap_1.2.0
#> [45] SparseArray_1.6.0 cli_3.6.3
#> [47] magrittr_2.0.3 S4Arrays_1.6.0
#> [49] XML_3.99-0.17 utf8_1.2.4
#> [51] filelock_1.0.3 UCSC.utils_1.2.0
#> [53] bit64_4.5.2 rmarkdown_2.28
#> [55] XVector_0.46.0 httr_1.4.7
#> [57] matrixStats_1.4.1 bit_4.5.0
#> [59] R.methodsS3_1.8.2 memoise_2.0.1
#> [61] evaluate_1.0.1 knitr_1.48
#> [63] BiocIO_1.16.0 rtracklayer_1.66.0
#> [65] rlang_1.1.4 glue_1.8.0
#> [67] DBI_1.2.3 BiocManager_1.30.25
#> [69] jsonlite_1.8.9 R6_2.5.1
#> [71] MatrixGenerics_1.18.0 GenomicAlignments_1.42.0
#> [73] zlibbioc_1.52.0