Learn R Programming

⚠️There's a newer version (3.0.1) of this package.Take me there.

scCustomize

scCustomize is a collection of functions created and/or curated to aid in the visualization and analysis of single-cell data using R.

Vignettes/Tutorials

See accompanying scCustomize website for detailed tutorials of all aspects of scCustomize functionality.

Installing scCustomize

scCustomize can be installed from CRAN on all platforms. For more detailed instructions see Installation.

# Base R
install.packages("scCustomize")

# Using pak
pak::pkg_install("scCustomize")

Release Notes

A full copy of the changes in each version can be found in the NEWS/ChangeLog.

Develop branch
I also maintain a separate development branch* that can be installed by supplying ref = "develop" in the devtools or remotes installation command. Version scheme vX.X.X.9yyy.
*Note: While this branch is typically mostly stable it may contain breaking issues/bugs.
I do try and keep development ChangeLog up to date so it’s easier to follow changes than reading commit history.

Bug Reports/New Features

If you run into any issues or bugs please submit a GitHub issue with details of the issue.

  • If possible please include a reproducible example (suggest using SeuratData package pbmc dataset for lightweight examples.)

Any requests for new features or enhancements can also be submitted as GitHub issues.

  • Even if you don’t know how to implement/incorporate with current package go ahead a submit!

Pull Requests are welcome for bug fixes, new features, or enhancements.

  • Please set PR to merge with “develop” branch and provide description of what the PR contains (referencing existing issue(s) if appropriate).

Copy Link

Version

Install

install.packages('scCustomize')

Monthly Downloads

3,091

Version

3.0.0

License

GPL (>= 3)

Issues

Pull Requests

Stars

Forks

Maintainer

Samuel Marsh

Last Published

December 5th, 2024

Functions in scCustomize (3.0.0)

Cells_per_Sample

Cells per Sample
Blank_Theme

Blank Theme
Change_Delim_Prefix

Change barcode prefix delimiter
Copy_To_GCP

Copy folder to GCP bucket from R Console
Create_10X_H5

Create H5 from 10X Outputs
Cluster_Stats_All_Samples

Calculate Cluster Stats
Cluster_Highlight_Plot

Cluster Highlight Plot
CheckMatrix_scCustom

Check Matrix Validity
DimPlot_All_Samples

DimPlot by Meta Data Column
Dark2_Pal

Dark2 Palette
Change_Delim_Suffix

Change barcode suffix delimiter
Create_Cluster_Annotation_File

Create cluster annotation csv file
Create_CellBender_Merged_Seurat

Create Seurat Object with Cell Bender and Raw data
DimPlot_scCustom

DimPlot with modified default settings
DimPlot_LIGER

DimPlot LIGER Version
Extract_Sample_Meta

Extract sample level meta.data
Extract_Top_Markers

Extract Top N Marker Genes
Convert_Assay

Convert between Seurat Assay types
Embeddings.liger

Extract matrix of embeddings
Extract_Modality

Extract multi-modal data into list by modality
Copy_From_GCP

Copy folder from GCP bucket from R Console
ColorBlind_Pal

Color Universal Design Short Palette
FeaturePlot_scCustom

Customize FeaturePlot
Clustered_DotPlot

Clustered DotPlot
DiscretePalette_scCustomize

Discrete color palettes
DotPlot_scCustom

Customized DotPlot
FeatureScatter_scCustom

Modified version of FeatureScatter
Feature_Present

Check if genes/features are present
Factor_Cor_Plot

Factor Correlation Plot
Features.liger

Extract Features from LIGER Object
FeaturePlot_DualAssay

Customize FeaturePlot of two assays
Iterate_PC_Loading_Plots

Iterate PC Loading Plots
Fetch_Meta

Get meta data from object
Iterate_Meta_Highlight_Plot

Iterate Meta Highlight Plot
Liger_to_Seurat

MAD_Stats

Median Absolute Deviation Statistics
Merge_Sparse_Data_All

Merge a list of Sparse Matrices
Plot_Density_Custom

Nebulosa Density Plot
Iterate_Plot_Density_Joint

Iterative Plotting of Gene Lists using Custom Joint Density Plots
Iterate_Barcode_Rank_Plot

Iterative Barcode Rank Plots
PC_Plotting

PC Plots
Plot_Density_Joint_Only

Nebulosa Joint Density Plot
Meta_Present

Check if meta data are present
Iterate_VlnPlot_scCustom

Iterative Plotting of Gene Lists using VlnPlot_scCustom
Find_Factor_Cor

Find Factor Correlations
Iterate_DimPlot_bySample

Iterate DimPlot By Sample
Merge_Sparse_Multimodal_All

Merge a list of Sparse Matrices contain multi-modal data.
Iterate_Cluster_Highlight_Plot

Iterate Cluster Highlight Plot
Idents.liger

Extract or set default identities from object
Hue_Pal

Hue_Pal
Iterate_Plot_Density_Custom

Iterative Plotting of Gene Lists using Custom Density Plots
Pull_Cluster_Annotation

Pull cluster information from annotation csv file.
QC_Plot_UMIvsFeature

QC Plots UMI vs Misc
Meta_Remove_Seurat

Remove meta data columns containing Seurat Defaults
JCO_Four

Four Color Palette (JCO)
Meta_Highlight_Plot

Meta Highlight Plot
Proportion_Plot

Cell Proportion Plot
Merge_Seurat_List

Merge a list of Seurat Objects
QC_Plot_GenevsFeature

QC Plots Genes vs Misc
QC_Plots_Feature

QC Plots Feature
NavyAndOrange

Navy and Orange Dual Color Palette
PalettePlot

Plot color palette in viewer
Iterate_FeaturePlot_scCustom

Iterative Plotting of Gene Lists using Custom FeaturePlots
Plot_Median_Mito

Plot Median Percent Mito per Cell per Sample
Median_Stats

Median Statistics
Move_Legend

Move Legend Position
QC_Plots_Complexity

QC Plots Cell "Complexity"
Plot_Median_Other

Plot Median other variable per Cell per Sample
QC_Plot_UMIvsGene

QC Plots Genes vs UMIs
Pull_Directory_List

Pull Directory List
Percent_Expressing

Calculate percent of expressing cells
Rename_Clusters

Rename Clusters
QC_Plots_UMIs

QC Plots UMIs
Meta_Numeric

Check if meta data columns are numeric
Plot_Median_Genes

Plot Median Genes per Cell per Sample
Seq_QC_Plot_Number_Cells

QC Plots Sequencing metrics
Read10X_GEO

Load in NCBI GEO data from 10X
Plot_Median_UMIs

Plot Median UMIs per Cell per Sample
Read_Metrics_10X

Read Overall Statistics from 10X Cell Ranger Count
Read10X_h5_GEO

Load in NCBI GEO data from 10X in HDF5 file format
QC_Plots_Combined_Vln

QC Plots Genes, UMIs, & % Mito
Seq_QC_Plot_Intronic

QC Plots Sequencing metrics (Alignment)
Reduction_Loading_Present

Check if reduction loadings are present
Plot_Cells_per_Sample

Plot Number of Cells/Nuclei per Sample
QC_Histogram

QC Histogram Plots
SpatialDimPlot_scCustom

SpatialDimPlot with modified default settings
Seq_QC_Plot_Genome

QC Plots Sequencing metrics (Alignment)
Read_GEO_Delim

Load in NCBI GEO data formatted as single file per sample
QC_Plots_Genes

QC Plots Genes
QC_Plots_Mito

QC Plots Mito
Split_Layers

Split Seurat object into layers
Read10X_h5_Multi_Directory

Load 10X h5 count matrices from multiple directories
Read_Metrics_CellBender

Read Overall Statistics from CellBender
Random_Cells_Downsample

Randomly downsample by identity
Split_Vector

Split vector into list
Read_CellBender_h5_Multi_File

Load CellBender h5 matrices (corrected) from multiple files
Seq_QC_Plot_Intergenic

QC Plots Sequencing metrics (Alignment)
UnRotate_X

Unrotate x axis on VlnPlot
Seq_QC_Plot_UMIs

QC Plots Sequencing metrics
Seq_QC_Plot_Alignment_Combined

QC Plots Sequencing metrics (Alignment) (Layout)
Replace_Suffix

Replace barcode suffixes
Seq_QC_Plot_Reads_in_Cells

QC Plots Sequencing metrics
VariableFeaturePlot_scCustom

Custom Labeled Variable Features Plot
Seq_QC_Plot_Reads_per_Cell

QC Plots Sequencing metrics
Read10X_Multi_Directory

Load 10X count matrices from multiple directories
Updated_HGNC_Symbols

Update HGNC Gene Symbols
Store_Misc_Info_Seurat

Store misc data in Seurat object
as.Seurat.liger

Convert objects to Seurat objects
Stacked_VlnPlot

Stacked Violin Plot
VlnPlot_scCustom

VlnPlot with modified default settings
Seq_QC_Plot_Transcriptome

QC Plots Sequencing metrics (Alignment)
as.anndata

Convert objects to anndata objects
Updated_MGI_Symbols

Update MGI Gene Symbols
ensembl_ieg_list

Immediate Early Gene (IEG) gene lists
ensembl_mito_id

Ensembl Mito IDs
seq_zeros

Create sequence with zeros
Seq_QC_Plot_Antisense

QC Plots Sequencing metrics (Alignment)
Seq_QC_Plot_Basic_Combined

QC Plots Sequencing metrics (Layout)
Store_Palette_Seurat

Store color palette in Seurat object
Variable_Features_ALL_LIGER

Perform variable gene selection over whole dataset
msigdb_qc_gene_list

QC Gene Lists
ieg_gene_list

Immediate Early Gene (IEG) gene lists
ensembl_ribo_id

Ensembl Ribo IDs
msigdb_qc_ensembl_list

QC Gene Lists
theme_ggprism_mod

Modified ggprism theme
Seq_QC_Plot_Saturation

QC Plots Sequencing metrics
Seq_QC_Plot_Total_Genes

QC Plots Sequencing metrics
Split_FeatureScatter

Read_CellBender_h5_Mat

Load CellBender h5 matrices (corrected)
ensembl_hemo_id

Ensembl Hemo IDs
Read_CellBender_h5_Multi_Directory

Load CellBender h5 matrices (corrected) from multiple directories
Seq_QC_Plot_Exonic

QC Plots Sequencing metrics (Alignment)
scCustomize-package

scCustomize: Custom Visualizations & Functions for Streamlined Analyses of Single Cell Sequencing
Seq_QC_Plot_Genes

QC Plots Sequencing metrics
scCustomize_Palette

Color Palette Selection for scCustomize
viridis_plasma_dark_high

Viridis Shortcuts
Setup_scRNAseq_Project

Setup project directory structure
Subset_LIGER

Subset LIGER object
Single_Color_Palette

Single Color Palettes for Plotting
Top_Genes_Factor

Extract top loading genes for LIGER factor
as.LIGER

Convert objects to LIGER objects
WhichCells.liger

Extract Cells for particular identity
plotFactors_scCustom

Customized version of plotFactors
reexports

Objects exported from other packages
Add_Hemo

Add Hemoglobin percentages
Add_Pct_Diff

Add percentage difference to DE results
Add_CellBender_Diff

Calculate and add differences post-cell bender analysis
Add_Cell_Complexity

Add Cell Complexity
Add_Cell_QC_Metrics

Add Multiple Cell Quality Control Values with Single Function
Add_Alt_Feature_ID

Add Alternative Feature IDs
Cells_by_Identities_LIGER

Extract Cells by identity
Case_Check

Check for alternate case features
CellBender_Diff_Plot

Plot Number of Cells/Nuclei per Sample
CellBender_Feature_Diff

CellBender Feature Differences
Add_Mito_Ribo

Add Mito and Ribo percentages
Add_Sample_Meta

Add Sample Level Meta Data
Cell_Highlight_Plot

Meta Highlight Plot
Add_Top_Gene_Pct

Add Percent of High Abundance Genes
Barcode_Plot

Create Barcode Rank Plot
Change_Delim_All

Change all delimiters in cell name
Cells.liger

Extract Cells from LIGER Object