Package: methylKit 1.31.0

Altuna Akalin

methylKit: DNA methylation analysis from high-throughput bisulfite sequencing results

methylKit is an R package for DNA methylation analysis and annotation from high-throughput bisulfite sequencing. The package is designed to deal with sequencing data from RRBS and its variants, but also target-capture methods and whole genome bisulfite sequencing. It also has functions to analyze base-pair resolution 5hmC data from experimental protocols such as oxBS-Seq and TAB-Seq. Methylation calling can be performed directly from Bismark aligned BAM files.

Authors:Altuna Akalin [aut, cre], Matthias Kormaksson [aut], Sheng Li [aut], Arsene Wabo [ctb], Adrian Bierling [aut], Alexander Blume [aut], Katarzyna Wreczycka [ctb]

methylKit_1.31.0.tar.gz
methylKit_1.31.0.zip(r-4.5)methylKit_1.31.0.zip(r-4.4)methylKit_1.31.0.zip(r-4.3)
methylKit_1.31.0.tgz(r-4.4-x86_64)methylKit_1.31.0.tgz(r-4.4-arm64)methylKit_1.31.0.tgz(r-4.3-x86_64)methylKit_1.31.0.tgz(r-4.3-arm64)
methylKit_1.31.0.tar.gz(r-4.5-noble)methylKit_1.31.0.tar.gz(r-4.4-noble)
methylKit.pdf |methylKit.html
methylKit/json (API)
NEWS

# Install 'methylKit' in R:
install.packages('methylKit', repos = c('https://bioc.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/al2na/methylkit/issues

Uses libs:
  • curl– Easy-to-use client-side URL transfer library
  • bzip2– High-quality block-sorting file compressor library
  • xz-utils– XZ-format compression library
  • zlib– Compression library
  • c++– GNU Standard C++ Library v3
Datasets:

On BioConductor:methylKit-1.31.0(bioc 3.20)methylKit-1.30.0(bioc 3.19)

bioconductor-package

57 exports 1.95 score 96 dependencies 3 dependents 154 mentions

Last updated 2 months agofrom:9edbc66cc8

Exports:adjust.methylCadjustMethylCannotate.WithFeatureannotate.WithFeature.Flankannotate.WithGenicPartsassocCompbedgraphcalculateDiffMethcalculateDiffMethDSSclusterSamplesdataSimdiffMethPerChrfilterByCoverageget.methylDiffgetAssemblygetContextgetCorrelationgetCoverageStatsgetDatagetDBPathgetFeatsWithTargetsStatsgetFlanksgetMembersgetMethylationStatsgetMethylDiffgetSampleIDgetSampleID<-getTargetAnnotationStatsgetTreatmentgetTreatment<-joinSegmentNeighboursmakeMethylDBmethReadmethSegmethSeg2bedmethylRawListmethylRawListDBnormalizeCoveragePCASamplespercMethylationplotTargetAnnotationpoolprocessBismarkAlnreadread.bedread.bismarkread.feature.flankread.transcript.featuresreadMethylDBreconstructregionCountsremoveCompreorganizeselectselectByOverlaptileMethylCountsunite

Dependencies:abindaskpassbbmlebdsmatrixBHBiobaseBiocGenericsBiocIOBiocParallelBiostringsbitopsclicodacodetoolscolorspacecpp11crayoncurldata.tableDelayedArrayemdbookfansifarverfastsegformatRfutile.loggerfutile.optionsGenomeInfoDbGenomeInfoDbDataGenomicAlignmentsGenomicRangesggplot2gluegtablegtoolshttrIRangesisobandjsonliteKernSmoothlabelinglambda.rlatticelifecyclelimmamagrittrMASSMatrixMatrixGenericsmatrixStatsmclustmgcvmimemunsellmvtnormnlmenumDerivopensslpillarpkgconfigplyrqvalueR.methodsS3R.ooR.utilsR6RColorBrewerRcppRCurlreshape2restfulrRhtslibrjsonrlangRsamtoolsrtracklayerS4ArraysS4VectorsscalessnowSparseArraystatmodstringistringrSummarizedExperimentsystibbleUCSC.utilsutf8vctrsviridisLitewithrXMLXVectoryamlzlibbioc

methylKit: User Guide vr packageVersion('methylKit')

Rendered frommethylKit.Rmdusingknitr::rmarkdownon Jun 30 2024.

Last update: 2020-12-14
Started: 2016-07-08

Readme and manuals

Help Manual

Help pageTopics
Adjust measured 5mC levels using 5hmC levelsadjustMethylC adjustMethylC,methylRaw,methylRaw-method adjustMethylC,methylRawDB,methylRawDB-method adjustMethylC,methylRawList,methylRawList-method adjustMethylC,methylRawListDB,methylRawListDB-method
Associate principal components with sample annotationsassocComp
Get bedgraph from methylRaw, methylRawList and methylDiff objectsbedgraph bedgraph,methylDiff-method bedgraph,methylDiffDB-method bedgraph,methylRaw-method bedgraph,methylRawDB-method bedgraph,methylRawList-method bedgraph,methylRawListDB-method
Calculate differential methylation statisticscalculateDiffMeth calculateDiffMeth,methylBase-method calculateDiffMeth,methylBaseDB-method
calculate Differential Methylation with DSScalculateDiffMethDSS calculateDiffMethDSS,methylBase-method
Hierarchical Clustering using methylation data The function clusters samples using 'hclust' function and various distance metrics derived from percent methylation per base or per region for each sample.clusterSamples clusterSamples,methylBase-method clusterSamples,methylBaseDB-method
Simulate DNA methylation datadataSim
Get and plot the number of hyper/hypo methylated regions/bases per chromosomediffMethPerChr diffMethPerChr,methylDiff-method diffMethPerChr,methylDiffDB-method
extract parts of methylRaw,methylRawDB,methylBase,methylBaseDB and methylDiff dataextract extract,methylBase,ANY-method extract,methylBaseDB,ANY-method extract,methylDiff,ANY-method extract,methylDiffDB,ANY-method extract,methylRaw,ANY-method extract,methylRawDB,ANY-method [,methylBase,ANY,ANY,ANY-method [,methylBaseDB,ANY,ANY,ANY-method [,methylDiff,ANY,ANY,ANY-method [,methylDiffDB,ANY,ANY,ANY-method [,methylRaw,ANY,ANY,ANY-method [,methylRawDB,ANY,ANY,ANY-method
Filter methylRaw, methylRawDB, methylRawList and methylRawListDB object based on read coveragefilterByCoverage filterByCoverage,methylRaw-method filterByCoverage,methylRawDB-method filterByCoverage,methylRawList-method filterByCoverage,methylRawListDB-method
get assembly of the genomegetAssembly getAssembly,methylBase-method getAssembly,methylBaseDB-method getAssembly,methylDiff-method getAssembly,methylDiffDB-method getAssembly,methylRaw-method getAssembly,methylRawDB-method
get the context of methylationgetContext getContext,methylBase-method getContext,methylBaseDB-method getContext,methylDiff-method getContext,methylDiffDB-method getContext,methylRaw-method getContext,methylRawDB-method
get correlation between samples in methylBase or methylBaseDB objectgetCorrelation getCorrelation,methylBase-method getCorrelation,methylBaseDB-method
get coverage stats from methylRaw objectgetCoverageStats getCoverageStats,methylRaw-method getCoverageStats,methylRawDB-method
get the data slot from the methylKit objectsgetData getData,methylBase-method getData,methylBaseDB-method getData,methylDiff-method getData,methylDiffDB-method getData,methylRaw-method getData,methylRawDB-method
Get path to database of the methylDB objectsgetDBPath getDBPath,methylBaseDB-method getDBPath,methylDiffDB-method getDBPath,methylRawDB-method getDBPath,methylRawListDB-method
get Methylation stats from methylRaw or methylRawDB objectgetMethylationStats getMethylationStats,methylRaw-method getMethylationStats,methylRawDB-method
get differentially methylated regions/bases based on cutoffsgetMethylDiff getMethylDiff,methylDiff-method getMethylDiff,methylDiffDB-method
Get or Set Sample-IDs of the methylKit objectsgetSampleID getSampleID,methylBase-method getSampleID,methylBaseDB-method getSampleID,methylDiff-method getSampleID,methylDiffDB-method getSampleID,methylRaw-method getSampleID,methylRawDB-method getSampleID,methylRawList-method getSampleID,methylRawListDB-method getSampleID<- getSampleID<-,methylBase-method getSampleID<-,methylBaseDB-method getSampleID<-,methylDiff-method getSampleID<-,methylDiffDB-method getSampleID<-,methylRaw-method getSampleID<-,methylRawDB-method getSampleID<-,methylRawList-method getSampleID<-,methylRawListDB-method
Get or Set treatment vector of methylKit objectgetTreatment getTreatment,getTreatment,methylDiffDB-method getTreatment,methylBase-method getTreatment,methylBaseDB-method getTreatment,methylDiff-method getTreatment,methylDiffDB-method getTreatment,methylRawList-method getTreatment,methylRawListDB-method getTreatment<- getTreatment<-,methylBase-method getTreatment<-,methylBaseDB-method getTreatment<-,methylDiff-method getTreatment<-,methylDiffDB-method getTreatment<-,methylRawList-method getTreatment<-,methylRawListDB-method
Join directly neighbouring segments produced by methSegjoinSegmentNeighbours
coerce methylKit objects from memory to flat file database objectsmakeMethylDB makeMethylDB,methylBase-method makeMethylDB,methylBase-methods makeMethylDB,methylDiff-method makeMethylDB,methylDiff-methods makeMethylDB,methylRaw-method makeMethylDB,methylRaw-methods makeMethylDB,methylRawList-method makeMethylDB,methylRawList-methods
read file(s) to methylRaw or methylRawList objectsmethRead methRead,character,ANY,ANY-method methRead,character,character,character-method methRead,character-method methRead,list,ANY,ANY-method methRead,list,list,character-method
Segment methylation or differential methylation profilemethSeg
Export segments to BED filesmethSeg2bed
An S4 class for methylation events sampled in multiple experimentsmethylBase methylBase-class
Example methylBase object.methylBase.obj
An S4 class for storing methylation events sampled in multiple experiments as flat file databasemethylBaseDB methylBaseDB-class
An S4 class that holds differential methylation informationmethylDiff methylDiff-class
Example methylKit objects.methylDiff.obj
An S4 class that holds differential methylation information as flat file databasemethylDiffDB methylDiffDB-class
Deprecated/Defunct functionsadjust.methylC annotate.WithFeature annotate.WithFeature.Flank annotate.WithGenicParts get.methylDiff getFeatsWithTargetsStats getFlanks getMembers getTargetAnnotationStats methylKit-defunct plotTargetAnnotation read read.bed read.bismark read.feature.flank read.transcript.features
An S4 class for holding raw methylation data from an alignment pipeline.methylRaw methylRaw-class
An S4 class for storing raw methylation data as flat file database.methylRawDB methylRawDB-class
An S4 class for holding a list of methylRaw objects.methylRawList methylRawList-class
Example methylRawList object.methylRawList.obj
An S4 class for holding a list of methylRawDB objects.methylRawListDB methylRawListDB-class
normalize read coverage between samplesnormalizeCoverage normalizeCoverage,methylRawList-method normalizeCoverage,methylRawListDB-method
Principal Components Analysis of Methylation dataPCASamples PCASamples,methylBase-method PCASamples,methylBaseDB-method
get percent methylation scores from methylBase or methylBaseDB objectpercMethylation percMethylation,methylBase-method percMethylation,methylBaseDB-method
Pool replicates within groups to a single sample per grouppool pool,methylBase-method pool,methylBaseDB-method
Get methylation percentage from sorted Bismark alignmentsprocessBismarkAln processBismarkAln,character,character,character-method processBismarkAln,list,list,character-method
load tabix file with header to methylDBreadMethylDB
Reconstruct methylBase or methylBaseDB object based on a new methylation percentage matrixreconstruct reconstruct,ANY,methylBase-method reconstruct,ANY,methylBaseDB-method reconstruct,methylBase-method reconstruct,methylBaseDB-method
Get regional counts for given GRanges or GRangesList objectregionCounts regionCounts,methylBase,GRanges-method regionCounts,methylBase,GRangesList-method regionCounts,methylBaseDB,GRanges-method regionCounts,methylBaseDB,GRangesList-method regionCounts,methylRaw,GRanges-method regionCounts,methylRaw,GRangesList-method regionCounts,methylRawDB,GRanges-method regionCounts,methylRawDB,GRangesList-method regionCounts,methylRawList,GRanges-method regionCounts,methylRawList,GRangesList-method regionCounts,methylRawListDB,GRanges-method regionCounts,methylRawListDB,GRangesList-method
Remove principal components from a methylBase objectremoveComp removeComp,methylBase-method removeComp,methylBaseDB-method
Reorganize methylKit objects by creating new objects from subset of samplesreorganize reorganize,methylBase-method reorganize,methylBaseDB-method reorganize,methylRawList-method reorganize,methylRawListDB-method
selects rows from of methylKit objectsselect select,methylBase-method select,methylBaseDB-method select,methylDiff-method select,methylDiffDB-method select,methylRaw-method select,methylRawDB-method
selects records of methylDB objects lying inside a GRanges rangeselectByOverlap selectByOverlap,methylBase,GRanges-method selectByOverlap,methylBase-method selectByOverlap,methylBaseDB,GRanges-method selectByOverlap,methylBaseDB-method selectByOverlap,methylDiff,GRanges-method selectByOverlap,methylDiff-method selectByOverlap,methylDiffDB,GRanges-method selectByOverlap,methylDiffDB-method selectByOverlap,methylRaw,GRanges-method selectByOverlap,methylRaw-method selectByOverlap,methylRawDB,GRanges-method selectByOverlap,methylRawDB-method selectByOverlap,methylRawList,GRanges-method selectByOverlap,methylRawList-method selectByOverlap,methylRawListDB,GRanges-method selectByOverlap,methylRawListDB-method
show method for methylKit classesshow,methylBase show,methylBase-method show,methylBaseDB show,methylBaseDB-method show,methylDiff show,methylDiff-method show,methylDiffDB show,methylDiffDB-method show,methylRaw show,methylRaw-method show,methylRawDB show,methylRawDB-method show,methylRawList show,methylRawList-method show,methylRawListDB show,methylRawListDB-method
Get methylated/unmethylated base counts for tilling windowstileMethylCounts tileMethylCounts,methylBase-method tileMethylCounts,methylBaseDB-method tileMethylCounts,methylRaw-method tileMethylCounts,methylRawDB-method tileMethylCounts,methylRawList-method tileMethylCounts,methylRawListDB-method
unite methylRawList to a single tableunite unite,methylRawList-method unite,methylRawListDB-method
update methylKit objects The method updates object from earlier versions (<v0.9.1) to latest object.updateMethObject