Skip to content
This repository was archived by the owner on Oct 14, 2025. It is now read-only.

Commit 6a2740a

Browse files
committed
small fixed to README and Vignette
1 parent 9f5de00 commit 6a2740a

File tree

3 files changed

+35
-21
lines changed

3 files changed

+35
-21
lines changed

README.Rmd

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@ title: "CuratedAtlasQueryR"
33
output: github_document
44
---
55

6+
<!-- badges: start -->
7+
[![Lifecycle:maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)
8+
<!-- badges: end -->
9+
10+
611
`CuratedAtlasQuery` is a query interface that allow the programmatic exploration and retrieval of the harmonised, curated and reannotated CELLxGENE single-cell human cell atlas. Data can be retrieved at cell, sample, or dataset levels based on filtering criteria.
712

813
```{r, include = FALSE}
@@ -206,7 +211,7 @@ Through harmonisation and curation we introduced custom column, not present in t
206211

207212
- `tissue_harmonised`: a coarser tissue name for better filtering
208213
- `age_days`: the number of days corresponding to the age
209-
- `cell_type_harmonised`: the consensus call identiti (for immune cells) using the original and three novel annotations using Seurat Azimuth and SingleR
214+
- `cell_type_harmonised`: the consensus call identity (for immune cells) using the original and three novel annotations using Seurat Azimuth and SingleR
210215
- `confidence_class`: an ordinal class of how confident `cell_type_harmonised` is. 1 is complete consensus, 2 is 3 out of four and so on.
211216
- `cell_annotation_azimuth_l2`: Azimuth cell annotation
212217
- `cell_annotation_blueprint_singler`: SingleR cell annotation using Blueprint reference
@@ -218,15 +223,15 @@ Through harmonisation and curation we introduced custom column, not present in t
218223

219224
# RNA abundance
220225

221-
The `raw` assay includes RNA abundance in the positive real scale (not transformed with non-linear functions, e.g. log sqrt). Originally CELLxGENE include a mix of scales and tranformations specified in the `x_normalization` column.
226+
The `raw` assay includes RNA abundance in the positive real scale (not transformed with non-linear functions, e.g. log sqrt). Originally CELLxGENE include a mix of scales and transformations specified in the `x_normalization` column.
222227

223228
The `cpm` assay includes counts per million.
224229

225230
---
226231

227-
This project have beeen funded by
232+
This project has been funded by
228233

229234
- *Silicon Valley Foundation* CZF2019-002443
230235
- *Bioconductor core funding* NIH NHGRI 5U24HG004059-18
231236
- *Victoria Cancer Agency* ECRF21036
232-
- *Australian National Health and Medical Research Council* 1116955
237+
- *Australian National Health and Medical Research Council* 1116955

README.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
CuratedAtlasQueryR
22
================
33

4+
<!-- badges: start -->
5+
6+
[![Lifecycle:maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)
7+
<!-- badges: end -->
8+
49
`CuratedAtlasQuery` is a query interface that allow the programmatic
510
exploration and retrieval of the harmonised, curated and reannotated
611
CELLxGENE single-cell human cell atlas. Data can be retrieved at cell,
@@ -64,18 +69,18 @@ get_metadata() |>
6469
dplyr::distinct(tissue, file_id)
6570
#> # Source: SQL [?? x 2]
6671
#> # Database: DuckDB 0.6.2-dev1166 [unknown@Linux 3.10.0-1160.81.1.el7.x86_64:R 4.2.0/:memory:]
67-
#> tissue file_id
68-
#> <chr> <chr>
69-
#> 1 lung 09132373-0ea7-4d8b-add8-9b0717781109
70-
#> 2 respiratory tract epithelium 09132373-0ea7-4d8b-add8-9b0717781109
71-
#> 3 cerebellum 3fe53a40-38ff-4f25-b33b-e4d60f2289ef
72-
#> 4 telencephalon 3fe53a40-38ff-4f25-b33b-e4d60f2289ef
73-
#> 5 cortex of kidney 62a6cd85-7d85-4958-b9d9-eb0c5f2fbd2f
74-
#> 6 cortex of kidney 63523aa3-0d04-4fc6-ac59-5cadd3e73a14
75-
#> 7 kidney 63523aa3-0d04-4fc6-ac59-5cadd3e73a14
76-
#> 8 renal medulla 63523aa3-0d04-4fc6-ac59-5cadd3e73a14
77-
#> 9 renal pelvis 63523aa3-0d04-4fc6-ac59-5cadd3e73a14
78-
#> 10 kidney blood vessel 63523aa3-0d04-4fc6-ac59-5cadd3e73a14
72+
#> tissue file_id
73+
#> <chr> <chr>
74+
#> 1 blood 07beec85-51be-4d73-bb80-8f85b7b643d5
75+
#> 2 blood 3431ab62-b11d-445f-a461-1408d2b29f8c
76+
#> 3 blood 5500774a-6ebe-4ddf-adce-90302b7cd007
77+
#> 4 blood 550760cb-ede9-4e6b-b6ab-7152f2ce29e1
78+
#> 5 blood a0396bf6-cd6d-42d9-b1b5-c66b19d312ae
79+
#> 6 cortex of kidney a1035da5-137b-4fac-8435-d1e4af20851c
80+
#> 7 blood a139b1d6-eba0-484d-860c-4fb810e17615
81+
#> 8 prefrontal cortex 27e51147-93c7-40c5-a6a3-da4b203e05ba
82+
#> 9 macula lutea proper 28d54b40-7a92-40cf-b164-a6c3158f55f6
83+
#> 10 fovea centralis 28d54b40-7a92-40cf-b164-a6c3158f55f6
7984
#> # … with more rows
8085
```
8186

@@ -302,7 +307,7 @@ present in the original CELLxGENE metadata
302307

303308
- `tissue_harmonised`: a coarser tissue name for better filtering
304309
- `age_days`: the number of days corresponding to the age
305-
- `cell_type_harmonised`: the consensus call identiti (for immune cells)
310+
- `cell_type_harmonised`: the consensus call identity (for immune cells)
306311
using the original and three novel annotations using Seurat Azimuth
307312
and SingleR
308313
- `confidence_class`: an ordinal class of how confident
@@ -322,14 +327,14 @@ present in the original CELLxGENE metadata
322327

323328
The `raw` assay includes RNA abundance in the positive real scale (not
324329
transformed with non-linear functions, e.g. log sqrt). Originally
325-
CELLxGENE include a mix of scales and tranformations specified in the
330+
CELLxGENE include a mix of scales and transformations specified in the
326331
`x_normalization` column.
327332

328333
The `cpm` assay includes counts per million.
329334

330335
------------------------------------------------------------------------
331336

332-
This project have beeen funded by
337+
This project has been funded by
333338

334339
- *Silicon Valley Foundation* CZF2019-002443
335340
- *Bioconductor core funding* NIH NHGRI 5U24HG004059-18

vignettes/Introduction.Rmd

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ vignette: >
77
%\VignetteEncoding{UTF-8}
88
---
99

10+
<!-- badges: start -->
11+
[![Lifecycle:maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)
12+
<!-- badges: end -->
13+
1014
`CuratedAtlasQuery` is a query interface that allow the programmatic exploration and retrieval of the harmonised, curated and reannotated CELLxGENE single-cell human cell atlas. Data can be retrieved at cell, sample, or dataset levels based on filtering criteria.
1115

1216
```{r, include = FALSE}
@@ -210,7 +214,7 @@ Through harmonisation and curation we introduced custom column, not present in t
210214

211215
- `tissue_harmonised`: a coarser tissue name for better filtering
212216
- `age_days`: the number of days corresponding to the age
213-
- `cell_type_harmonised`: the consensus call identiti (for immune cells) using the original and three novel annotations using Seurat Azimuth and SingleR
217+
- `cell_type_harmonised`: the consensus call identity (for immune cells) using the original and three novel annotations using Seurat Azimuth and SingleR
214218
- `confidence_class`: an ordinal class of how confident `cell_type_harmonised` is. 1 is complete consensus, 2 is 3 out of four and so on.
215219
- `cell_annotation_azimuth_l2`: Azimuth cell annotation
216220
- `cell_annotation_blueprint_singler`: SingleR cell annotation using Blueprint reference
@@ -222,6 +226,6 @@ Through harmonisation and curation we introduced custom column, not present in t
222226

223227
# RNA abundance
224228

225-
The `raw` assay includes RNA abundance in the positive real scale (not transformed with non-linear functions, e.g. log sqrt). Originally CELLxGENE include a mix of scales and tranformations specified in the `x_normalization` column.
229+
The `raw` assay includes RNA abundance in the positive real scale (not transformed with non-linear functions, e.g. log sqrt). Originally CELLxGENE include a mix of scales and transformations specified in the `x_normalization` column.
226230

227231
The `cpm` assay includes counts per million.

0 commit comments

Comments
 (0)