Skip to content

Commit 47199ac

Browse files
authored
debugging
2 parents ff93c23 + c3fe3f8 commit 47199ac

File tree

14 files changed

+289
-431
lines changed

14 files changed

+289
-431
lines changed

.Rbuildignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
^CODE_OF_CONDUCT\.md$
88
^CONTRIBUTING\.md$
99
^LICENSE\.md$
10-
^PUBLISHING\.md$
10+
^publishing\.md$
1111
^README\.md$
12+
^cran-comments\.md$
1213
^cellucid-logo\.svg$

.github/workflows/R-CMD-check.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ name: R-CMD-check
55
# If this workflow is green, you are generally in good shape for:
66
# - GitHub releases
77
# - CRAN submission (see publishing.md for the final `--as-cran` steps)
8-
# - Bioconductor submission (also run the BiocCheck workflow)
98

109
on:
1110
push:

.github/workflows/bioccheck.yaml

Lines changed: 0 additions & 87 deletions
This file was deleted.

.github/workflows/release.yaml

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
# This workflow is designed for beginners:
44
# - Create a GitHub Release (or run manually)
55
# - Download the `.tar.gz` artifact from the workflow run
6-
# - Upload that exact tarball to CRAN, or attach it in your Bioconductor submission
6+
# - Upload that exact tarball to CRAN
77
#
8-
# This does *not* auto-submit to CRAN/Bioconductor (those still require a human),
8+
# This does *not* auto-submit to CRAN (that still requires a human),
99
# but it automates the parts that are easy to get wrong: reproducible building
1010
# and pre-flight checks.
1111

@@ -43,6 +43,15 @@ jobs:
4343

4444
- uses: r-lib/actions/setup-tinytex@v2
4545

46+
- name: Ensure pdflatex is available
47+
run: |
48+
if ! command -v pdflatex >/dev/null 2>&1; then
49+
sudo apt-get update
50+
sudo apt-get install -y texlive-latex-base texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended
51+
fi
52+
pdflatex --version
53+
shell: bash
54+
4655
- uses: r-lib/actions/setup-r-dependencies@v2
4756
with:
4857
extra-packages: any::rcmdcheck, local::.

CITATION.cff

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ cff-version: 1.2.0
22
message: "If you use this software, please cite it."
33
type: software
44
title: "cellucid (R): Export Single-Cell Data to the Cellucid Viewer Format"
5-
version: 0.99.0 # CELLUCID_VERSION
5+
version: 0.9.0 # CELLUCID_VERSION
66
authors:
77
- family-names: Inecik
88
given-names: Kemal

CONTRIBUTING.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Cellucid is split by responsibility:
1717
|---|---|---|
1818
| `cellucid` | Web app (UI + state + WebGL rendering) | are fixing UI bugs, rendering/performance, figure export, sessions, or community annotation frontend |
1919
| `cellucid-python` | Python package + CLI (`prepare`, `serve`, `show_anndata`, hooks) + Sphinx docs | are fixing Python/CLI bugs, data prep/export, server endpoints, Jupyter hooks, or docs on ReadTheDocs |
20-
| `cellucid-r` (this repo) | R package for exporting data to the Cellucid viewer format | are changing the R exporter (`cellucid_prepare()`), adding R-side tests/docs, or preparing for Bioconductor |
20+
| `cellucid-r` (this repo) | R package for exporting data to the Cellucid viewer format | are changing the R exporter (`cellucid_prepare()`), adding R-side tests/docs, or preparing for CRAN |
2121
| `cellucid-annotation` | GitHub repo template for community annotation | are changing the repo schema/validation/workflows |
2222

2323
If you’re not sure where a bug belongs, open an issue in the repo you’re currently using and include:
@@ -48,7 +48,7 @@ If the bug is “the viewer looks wrong”, also include:
4848

4949
Docs live in:
5050
- `cellucid-r/man/` (generated `.Rd` files)
51-
- `cellucid-r/vignettes/` (BiocStyle vignette)
51+
- `cellucid-r/vignettes/` (package vignette)
5252
- `cellucid-r/README.md`
5353

5454
If you edit `.Rd` files directly, be aware they are usually generated from roxygen comments in `cellucid-r/R/`.
@@ -60,7 +60,7 @@ Fast workflow:
6060
1) Set up your R dev environment (see “Development setup”)
6161
2) Make a small, focused change
6262
3) Add/adjust tests (`testthat`)
63-
4) Run `devtools::check()` (and `BiocCheck::BiocCheck()` if relevant)
63+
4) Run `devtools::check()`
6464
5) Submit a PR with a clear “what/why/how to verify”
6565

6666
---
@@ -91,19 +91,15 @@ In R:
9191
install.packages(c("devtools", "roxygen2", "testthat"))
9292
```
9393

94-
For vignette builds and Bioconductor-style docs:
94+
For vignette builds:
9595

9696
```r
97-
if (!requireNamespace("BiocManager", quietly = TRUE)) {
98-
install.packages("BiocManager")
99-
}
100-
BiocManager::install(c("BiocStyle", "knitr", "rmarkdown"))
97+
install.packages(c("knitr", "rmarkdown"))
10198
```
10299

103100
Optional (useful during release prep):
104101

105102
```r
106-
BiocManager::install("BiocCheck")
107103
install.packages(c("pkgdown", "covr"))
108104
```
109105

@@ -135,12 +131,6 @@ Run a full check (recommended before PRs):
135131
devtools::check()
136132
```
137133

138-
For Bioconductor submission readiness:
139-
140-
```r
141-
BiocCheck::BiocCheck(".")
142-
```
143-
144134
Guidelines:
145135
- Add tests when behavior changes (especially edge cases like missing values, mismatched dimensions, sparse matrices).
146136
- Prefer small synthetic inputs; avoid committing real datasets.
@@ -183,7 +173,7 @@ This package is intentionally:
183173

184174
- **minimal-dependency** (only `jsonlite` is a hard dependency)
185175
- **format-first** (exports must match what the web app expects)
186-
- **Bioconductor-friendly** (checks, vignette style, and package structure matter)
176+
- **CRAN-ready** (checks, documentation, and package structure matter)
187177

188178
If you propose adding a new dependency:
189179
- prefer `Suggests` over `Imports` unless strictly required
@@ -240,7 +230,7 @@ Fix:
240230
### `R CMD check` fails on vignettes
241231

242232
Common causes:
243-
- missing suggested packages (`BiocStyle`, `knitr`, `rmarkdown`)
233+
- missing suggested packages (`knitr`, `rmarkdown`)
244234
- missing Pandoc
245235

246236
Fix:

DESCRIPTION

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Package: cellucid
22
Type: Package
33
Title: Export Single-Cell Data to the Cellucid Viewer Format
4-
Version: 0.99.0
4+
Version: 0.9.0
55
X-Cellucid-Version-Marker: CELLUCID_VERSION
66
Authors@R: c(
77
person(
@@ -21,13 +21,11 @@ Depends:
2121
Imports:
2222
jsonlite
2323
Suggests:
24-
BiocStyle,
2524
knitr,
2625
Matrix,
2726
rmarkdown,
2827
testthat (>= 3.1.0)
2928
VignetteBuilder: knitr
30-
biocViews: SingleCell, Visualization, DataRepresentation
3129
Config/testthat/edition: 3
3230
URL: https://github.com/theislab/cellucid-r,
3331
https://theislab.github.io/cellucid-r/

NEWS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# cellucid 0.99.0 <!-- CELLUCID_VERSION -->
1+
# cellucid 0.9.0 <!-- CELLUCID_VERSION -->
22

3-
- Initial Bioconductor submission version.
3+
- Initial CRAN submission version.
44
- Adds `cellucid_prepare()` / `prepare()` to export embeddings, metadata, gene expression, and connectivity to the Cellucid viewer format.
55
- Rejects duplicate gene IDs and filename-sanitization collisions (obs keys / gene IDs) to prevent silent overwrites in exports.

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,11 @@ cellucid_prepare(
5454

5555
## Links
5656

57-
- Web app: https://cellucid.com
58-
- R package docs (installation + recipes): https://cellucid.readthedocs.io/en/latest/user_guide/r_package/index.html
59-
- Seurat recipe: https://cellucid.readthedocs.io/en/latest/user_guide/r_package/e_integrations_recipes/01_seurat_recipe.html
60-
- SingleCellExperiment recipe: https://cellucid.readthedocs.io/en/latest/user_guide/r_package/e_integrations_recipes/02_singlecellexperiment_recipe.html
61-
- Source: https://github.com/theislab/cellucid-r
62-
- Viewer: https://github.com/theislab/cellucid
63-
- Citation: `citation("cellucid")` (or `CITATION.cff`)
57+
- [Web app](https://cellucid.com)
58+
- [Documentation](https://cellucid.readthedocs.io/en/latest/user_guide/r_package/index.html)
59+
- Recipes: [Seurat](https://cellucid.readthedocs.io/en/latest/user_guide/r_package/e_integrations_recipes/01_seurat_recipe.html) · [SingleCellExperiment](https://cellucid.readthedocs.io/en/latest/user_guide/r_package/e_integrations_recipes/02_singlecellexperiment_recipe.html)
60+
- Source: [cellucid-r](https://github.com/theislab/cellucid-r) · [cellucid](https://github.com/theislab/cellucid)
61+
- Citation: `citation("cellucid")`
6462

6563
## License
6664

cran-comments.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## R CMD check results
2+
3+
0 errors | 0 warnings | 0 notes
4+
5+
## Test environments
6+
7+
- GitHub Actions: ubuntu-latest, windows-latest, macos-latest (R release, R devel, R oldrel-1)
8+
9+
## Notes
10+
11+
This is a new submission.

0 commit comments

Comments
 (0)