Package: BatChef 1.1.4

Elena Zuin
BatChef: Single-cell RNA-seq batch effects correction methods interface
This package implements a variety of methods for batch correction in single-cell RNA sequencing (scRNA-seq) data. It incorporates quantitative metrics (e.g. Wasserstein distance, Adjusted Rand Index) to evaluate their performance. Furthermore, the package assists users in identifying and applying the optimal method for specific datasets.
Authors:
BatChef_1.1.4.tar.gz
BatChef_1.1.4.tgz(r-4.6-x86_64)BatChef_1.1.4.tgz(r-4.6-arm64)BatChef_1.1.4.tgz(r-4.5-x86_64)BatChef_1.1.4.tgz(r-4.5-arm64)
BatChef_1.1.4.tar.gz(r-4.7-arm64)BatChef_1.1.4.tar.gz(r-4.7-x86_64)BatChef_1.1.4.tar.gz(r-4.6-arm64)BatChef_1.1.4.tar.gz(r-4.6-x86_64)
BatChef_1.1.4.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
BatChef/json (API)
| # Install 'BatChef' in R: |
| install.packages('BatChef', repos = c('https://bioc.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/zuinelena3/batchef/issues
On BioConductor:BatChef-1.1.3(bioc 3.24)BatChef-1.0.2(bioc 3.23)
batcheffectsinglecellsequencingcpp
Last updated from:7976ac4360. Checks:1 NOTE, 13 WARNING, 2 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| bioc-checks | NOTE | 301 | ||
| linux-devel-arm64 | WARNING | 1520 | ||
| linux-devel-x86_64 | WARNING | 1613 | ||
| source / vignettes | OK | 453 | ||
| linux-release-arm64 | WARNING | 1504 | ||
| linux-release-x86_64 | WARNING | 1594 | ||
| macos-release-arm64 | WARNING | 1207 | ||
| macos-release-x86_64 | WARNING | 2294 | ||
| macos-oldrel-arm64 | WARNING | 1280 | ||
| macos-oldrel-x86_64 | WARNING | 2437 | ||
| windows-devel-arm64 | WARNING | 241 | ||
| windows-devel-x86_64 | WARNING | 187 | ||
| windows-release-arm64 | WARNING | 303 | ||
| windows-release-x86_64 | WARNING | 139 | ||
| windows-oldrel-x86_64 | WARNING | 171 | ||
| wasm-release | OK | 260 |
Exports:adjusted_rand_indexaverage_silhouette_widthbatchCorrectBBKNNParamsbbknnRunCombatParamscombatRuncompute_lisiFastMNNParamsfastMNNRunHarmonyParamsharmonyRunleiden_clusteringLigerParamsligerRunLimmaParamslimmaRunlocal_inverse_simpson_indexmetricsnormalized_mutual_infoScanoramaParamsscanoramaRunScMerge2ParamsscMerge2RunSeuratV3ParamsseuratV3RunSeuratV5ParamsseuratV5Runsimulate_datasuggested_methodwasserstein_distance
Dependencies:abindanndataRannotateAnnotationDbiaricodeaskpassassortheadbackportsbase64encbasiliskbatchelorbbmlebdsmatrixbeachmatbeeswarmBHBiobaseBiocBaseUtilsBiocGenericsbiocmakeBiocNeighborsBiocParallelBiocSingularBiostringsbitbit64bitopsblobblusterbslibcachemCairocallrcaToolscheckmatecirclizeclassclassIntcliclustercodetoolscolorspacecowplotcpp11crayoncurlcvToolsdata.tableDBIDelayedArrayDelayedMatrixStatsdensEstBayesDEoptimRdescdigestdir.expirydistrdistributionaldotCall64dplyrdqrnge1071easy.utilsedgeRevaluatefarverfastDummiesfastmapfastmatchfilelockfitdistrplusFNNfontawesomeforcatsforeignformatRFormulafsfutile.loggerfutile.optionsfuturefuture.applygenefiltergenericsGenomicRangesggbeeswarmggplot2ggprismggrastrggrepelggridgesGlobalOptionsglobalsgluegplotsgridExtragtablegtoolsh5mreadharmonyHDF5Arrayhdf5rhdf5r.ExtrahereHighFivehighrHmischmshtmlTablehtmltoolshtmlwidgetshttricaigraphinlineIRangesirlbaisobandjanitorjquerylibjsonliteKEGGRESTKernSmoothknitrlabelinglambda.rlatticeleidenAlglifecyclelimmalistenvlocfitloolubridateM3DropmagrittrMASSMatrixMatrixGenericsmatrixStatsmclustmcprogressmemoisemetapodmgcvmimemvtnormnlmennetnumDerivopensslotelpaletteerparallellypatchworkpbapplypbmcapplypheatmappillarpkgbuildpkgconfigplsplyrpngposteriorprismaticpROCprocessxprogressrproxyproxyCpspurrrQuickJSRR6raggRANNrappdirsRColorBrewerRcppRcppAnnoyRcppArmadilloRcppEigenRcppHNSWRcppMLRcppParallelRcppPlancRcppProgressRcppThreadRcppTOMLreldistrematch2reshape2ResidualMatrixreticulaterhdf5rhdf5filtersRhdf5libRhpcBLASctlRigraphlibrlangrligerrmarkdownrobustbaserpartrprojrootRSpectraRSQLiterstanrstantoolsrstudioapirsvdRtsneruvs2S4ArraysS4VectorsS7sassScaledMatrixscalesscaterscattermoresccorescCustomizescMergescranscrappersctransformscuttleSeqinfoSeuratSeuratObjectsfsfsmiscshapeSingleCellExperimentsitmosnakecasesnowspspamSparseArraysparseMatrixStatssplatterStanHeadersstartupmsgstatmodstringistringrSummarizedExperimentsurvivalsvasyssystemfontstensorAtextshapingtibbletidyrtidyselecttimechangetinytextransportunitsutf8uwotvctrsviporviridisviridisLitewithrwkxfunXMLxtableXVectoryaml
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Adjusted Rand Index (ARI) | adjusted_rand_index |
| Average Silhouette Width (ASW) | average_silhouette_width |
| Batch effects strength | batch_params |
| batchCorrect | batchCorrect batchCorrect,BBKNNParams-method batchCorrect,CombatParams-method batchCorrect,FastMNNParams-method batchCorrect,HarmonyParams-method batchCorrect,LigerParams-method batchCorrect,LimmaParams-method batchCorrect,ScanoramaParams-method batchCorrect,ScMerge2Params-method batchCorrect,SeuratV3Params-method batchCorrect,SeuratV5Params-method |
| Convert into a BBKNN compatible object | bbknnInput bbknnInput,ANY-method bbknnInput,InMemoryAnnData,InMemoryAnnData-method bbknnInput,Seurat,Seurat-method bbknnInput,Seurat-method bbknnInput,SingleCellExperiment,SingleCellExperiment-method bbknnInput,SingleCellExperiment-method |
| Convert BBKNN output | bbknnPost bbknnPost,ANY-method bbknnPost,InMemoryAnnData,InMemoryAnnData-method bbknnPost,Seurat,Seurat-method bbknnPost,Seurat-method bbknnPost,SingleCellExperiment,SingleCellExperiment-method bbknnPost,SingleCellExperiment-method |
| BBKNN method | bbknnRun |
| Capture parameters of the correction methods | capture_params |
| Convert into a SingleCellExperiment object for clustering | clustInput clustInput,ANY-method clustInput,InMemoryAnnData,InMemoryAnnData-method clustInput,Seurat,Seurat-method clustInput,Seurat-method clustInput,SingleCellExperiment,SingleCellExperiment-method clustInput,SingleCellExperiment-method |
| ComBat method | combatRun |
| Local Inverse Simpson Index (LISI) | compute_lisi |
| Compute the Local Inverse Simpson Index (LISI) | compute_simpson_index |
| Extract data characteristics | extract_features |
| Convert fastMNN output | fastMNNPost fastMNNPost,ANY-method fastMNNPost,InMemoryAnnData,InMemoryAnnData-method fastMNNPost,Seurat,Seurat-method fastMNNPost,Seurat-method fastMNNPost,SingleCellExperiment,SingleCellExperiment-method fastMNNPost,SingleCellExperiment-method |
| fastMNN method | fastMNNRun |
| Convert Harmony output | harmonyPost harmonyPost,ANY-method harmonyPost,InMemoryAnnData,InMemoryAnnData-method harmonyPost,Seurat,Seurat-method harmonyPost,Seurat-method harmonyPost,SingleCellExperiment,SingleCellExperiment-method harmonyPost,SingleCellExperiment-method |
| Harmony method | harmonyRun |
| Kullback-Leibler (KL) divergence) between two Gamma distributions | kl_gamma |
| Leiden clustering | leiden_clustering |
| Library size parameters | lib_size_params |
| Convert to a LIGER compatible object | ligerInput ligerInput,ANY-method ligerInput,InMemoryAnnData,InMemoryAnnData-method ligerInput,Seurat,Seurat-method ligerInput,Seurat-method ligerInput,SingleCellExperiment,SingleCellExperiment-method ligerInput,SingleCellExperiment-method |
| Convert the LIGER output | ligerPost ligerPost,ANY-method ligerPost,InMemoryAnnData,InMemoryAnnData-method ligerPost,Seurat,Seurat-method ligerPost,Seurat-method ligerPost,SingleCellExperiment,SingleCellExperiment-method ligerPost,SingleCellExperiment-method |
| LIGER method | ligerRun |
| BatChefParams methods | BatChefParams-class BBKNNParams BBKNNParams-class CombatParams CombatParams-class FastMNNParams FastMNNParams-class HarmonyParams HarmonyParams-class LigerParams LigerParams-class LimmaParams LimmaParams-class ScanoramaParams ScanoramaParams-class ScMerge2Params ScMerge2Params-class SeuratV3Params SeuratV3Params-class SeuratV5Params SeuratV5Params-class |
| limma method | limmaRun |
| Convert into a SingleCellExperiment object for linear model based methods | linearInput linearInput,ANY-method linearInput,InMemoryAnnData,InMemoryAnnData-method linearInput,Seurat,Seurat-method linearInput,Seurat-method linearInput,SingleCellExperiment,SingleCellExperiment-method linearInput,SingleCellExperiment-method |
| Convert the output of linear models | linearPost linearPost,ANY-method linearPost,InMemoryAnnData,InMemoryAnnData-method linearPost,Seurat,Seurat-method linearPost,Seurat-method linearPost,SingleCellExperiment,SingleCellExperiment-method linearPost,SingleCellExperiment-method |
| Median of Local Inverse Simposon Index (LISI) | local_inverse_simpson_index |
| A shifted log transformation | log_transf |
| Parameters merging | merge_params |
| Performance evaluation metrics. | metrics |
| Normalization | normalized |
| Normalized Mutual Information (NMI) | normalized_mutual_info |
| Highly expressed genes probability | outlier_params |
| Gamma parameters estimation of batch factors | params_btc_factors |
| Prediction plot | prediction_plot |
| Convert to a Scanorama compatible object | anndatasInput,InMemoryAnnData,InMemoryAnnData-method anndatasInput,Seurat,Seurat-method anndatasInput,SingleCellExperiment,SingleCellExperiment-method scanoramaInput scanoramaInput,ANY-method scanoramaInput,Seurat-method scanoramaInput,SingleCellExperiment-method |
| Convert the Scanorama output | scanoramaPost scanoramaPost,ANY-method scanoramaPost,InMemoryAnnData,InMemoryAnnData-method scanoramaPost,Seurat,Seurat-method scanoramaPost,Seurat-method scanoramaPost,SingleCellExperiment,SingleCellExperiment-method scanoramaPost,SingleCellExperiment-method |
| Scanorama method | scanoramaRun |
| Convert into a SingleCellExperiment object | sceInput sceInput,ANY-method sceInput,InMemoryAnnData,InMemoryAnnData-method sceInput,Seurat,Seurat-method sceInput,Seurat-method sceInput,SingleCellExperiment,SingleCellExperiment-method sceInput,SingleCellExperiment-method |
| Convert the scMerge2 output | scMerge2Post scMerge2Post,ANY-method scMerge2Post,InMemoryAnnData,InMemoryAnnData-method scMerge2Post,Seurat,Seurat-method scMerge2Post,Seurat-method scMerge2Post,SingleCellExperiment,SingleCellExperiment-method scMerge2Post,SingleCellExperiment-method |
| scMerge2 method | scMerge2Run |
| Convert to a SeuratV3 compatible object | seuratv3Input seuratv3Input,ANY-method seuratv3Input,InMemoryAnnData,InMemoryAnnData-method seuratv3Input,Seurat,Seurat-method seuratv3Input,Seurat-method seuratv3Input,SingleCellExperiment,SingleCellExperiment-method seuratv3Input,SingleCellExperiment-method |
| Convert the SeuratV3 output | seuratv3Post seuratv3Post,ANY-method seuratv3Post,InMemoryAnnData,InMemoryAnnData-method seuratv3Post,Seurat,Seurat-method seuratv3Post,Seurat-method seuratv3Post,SingleCellExperiment,SingleCellExperiment-method seuratv3Post,SingleCellExperiment-method |
| Seurat V3 method | seuratV3Run |
| Convert to a SeuratV5 compatible object | seuratv5Input seuratv5Input,ANY-method seuratv5Input,InMemoryAnnData,InMemoryAnnData-method seuratv5Input,Seurat,Seurat-method seuratv5Input,Seurat-method seuratv5Input,SingleCellExperiment,SingleCellExperiment-method seuratv5Input,SingleCellExperiment-method |
| Convert the SeuratV5 output | seuratv5Post seuratv5Post,ANY-method seuratv5Post,InMemoryAnnData,InMemoryAnnData-method seuratv5Post,Seurat,Seurat-method seuratv5Post,Seurat-method seuratv5Post,SingleCellExperiment,SingleCellExperiment-method seuratv5Post,SingleCellExperiment-method |
| Seurat V5 method | seuratV5Run |
| Function to simulate data | simulate_data |
| Suggested method prediction | suggested_method |
| Wasserstein distance | wasserstein_distance |
| Winsorization | winsorization |
