Installation#

Audience: everyone
Time: 5–15 minutes (depending on your setup) Goal: install Cellucid for R, verify version 0.9.1, and choose the correct source for current registry availability

Note

Active package version: 0.9.1. Version 0.9.1 is the CRAN submission release. The CRAN package index is authoritative for registry availability. Use the CRAN command below when the index lists cellucid 0.9.1; otherwise install the active source from the official GitHub repository.

Requirements#

  • R: cellucid currently targets R ≥ 4.3.0.

  • Hard dependency: jsonlite

  • Optional but recommended: Matrix (sparse matrices + connectivities)

Note

cellucid-r is designed to be dependency-light and does not require Seurat or SingleCellExperiment. Those packages are only needed if you want to follow the Seurat/SCE recipes in this guide.

Install Cellucid#

From CRAN when version 0.9.1 is listed#

When the CRAN package index lists cellucid 0.9.1, install it with:

install.packages("cellucid")

If the index does not list version 0.9.1 yet, use the official source installation below.

From the official source repository#

Option A: remotes (simple, common)#

install.packages("remotes")
remotes::install_github("theislab/cellucid-r")

Option B: pak (often faster, better resolver)#

install.packages("pak")
pak::pak("theislab/cellucid-r")

Verify the installation#

library(cellucid)
packageVersion("cellucid")

You should see:

  • No error on library(cellucid)

  • Version 0.9.1 from packageVersion

Troubleshooting installation#

Symptom: “package ‘jsonlite’ is not available”#

Likely causes

  • You are using an R environment without CRAN configured.

  • You are offline or behind a restrictive proxy.

How to confirm

  • Run getOption("repos") and verify you have a CRAN mirror set.

Fix

options(repos = c(CRAN = "https://cloud.r-project.org"))
install.packages("jsonlite")

Symptom: GitHub install fails (“HTTP error 401/403”, “rate limit”)#

Likely causes

  • Corporate proxy / blocked GitHub

  • GitHub API rate limiting

Fix options

  • Try pak (often more resilient).

  • If needed, configure a GitHub PAT:

    • Sys.setenv(GITHUB_PAT = "...")

Symptom: “there is no package called ‘Matrix’”#

Fix

install.packages("Matrix")

Symptom: you installed but library(cellucid) loads the wrong version#

How to confirm

find.package("cellucid")
packageVersion("cellucid")

Fix

  • Restart R (RStudio: Session → Restart R).

  • Reinstall with:

    remotes::install_github("theislab/cellucid-r", force = TRUE)

Next steps#