Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
130 commits
Select commit Hold shift + click to select a range
c6abc4f
reorganize download files and add project download section
allyhawkins May 6, 2025
efb2695
capital QC
allyhawkins May 6, 2025
26d527b
Apply suggestions from code review
allyhawkins May 7, 2025
8194601
clarify metadata-only section in portal wide downloads
allyhawkins May 7, 2025
8f93c26
update OSCA links
allyhawkins May 7, 2025
e18b5b1
Clarify TODO
allyhawkins May 7, 2025
5e11212
Merge pull request #411 from AlexsLemonade/allyhawkins/391-project-do…
allyhawkins May 7, 2025
09222e8
data format section
sjspielman May 7, 2025
e667e71
fill in a stub
sjspielman May 7, 2025
dc99f85
add modality section
sjspielman May 7, 2025
ebe8641
add a todo
sjspielman May 7, 2025
211d02d
phrasing
sjspielman May 7, 2025
5cadfd9
update modality section based on input from deepa
sjspielman May 7, 2025
56fc755
add download_options to index
sjspielman May 7, 2025
0fb76af
Apply suggestions from code review
sjspielman May 8, 2025
da79126
Apply suggestions from code review
sjspielman May 8, 2025
53564c0
add transcriptomic to dictionary
sjspielman May 8, 2025
0f603e3
some rephrasing in response to review
sjspielman May 8, 2025
355a4e3
fix rel links and clarify only one modality at a time per thing
sjspielman May 8, 2025
6493804
stub link to images
sjspielman May 8, 2025
f1afafe
add section on custom datasets
allyhawkins May 8, 2025
63df1d0
spell downloads
allyhawkins May 8, 2025
4337179
Apply suggestions from code review
sjspielman May 9, 2025
0421f3a
Apply suggestions from code review
allyhawkins May 9, 2025
aad401f
some more wordsmithing
allyhawkins May 9, 2025
2f10c48
add project ID to bulk file
allyhawkins May 9, 2025
38f7670
various rephrasing to get the nuances communicated more clearly
sjspielman May 9, 2025
35edbc8
bulk rephrase
sjspielman May 9, 2025
4c5b46d
fix rellink
sjspielman May 9, 2025
ed74a02
add a merged objects section
sjspielman May 9, 2025
820dbb1
Update docs/download_options.md
sjspielman May 9, 2025
fdc1874
Update docs/download_options.md
sjspielman May 9, 2025
f36fd45
Apply suggestions from code review
sjspielman May 9, 2025
1d544ae
add download link which i hadn't actually committed
sjspielman May 9, 2025
b58e279
use given
sjspielman May 9, 2025
dba9896
Update docs/download_options.md
sjspielman May 9, 2025
2865fbd
ok try one spatial sentence
sjspielman May 9, 2025
add93b1
add a spatial TODO, which can get resolved in #412
sjspielman May 9, 2025
79fbccf
Merge pull request #413 from AlexsLemonade/sjspielman/386-387-data-fo…
sjspielman May 9, 2025
3673e68
Merge branch 'development' into sjspielman/388-merge-options
sjspielman May 9, 2025
7e963a6
Merge pull request #415 from AlexsLemonade/sjspielman/388-merge-options
sjspielman May 9, 2025
0f4cbf2
Merge branch 'development' into allyhawkins/390-custom-datasets
allyhawkins May 12, 2025
63bae56
remove extra TODO
allyhawkins May 12, 2025
21138f0
WIP on allyhawkins/390-custom-datasets
allyhawkins May 12, 2025
b1850c0
appease the robots
allyhawkins May 12, 2025
bc4fc4c
Apply suggestions from code review
allyhawkins May 13, 2025
1fccc48
clarify cell and nuclei in merged
allyhawkins May 13, 2025
6b984c2
Merge pull request #416 from AlexsLemonade/allyhawkins/410-portal-wid…
allyhawkins May 13, 2025
ac35751
add multiplex section
sjspielman May 13, 2025
168d5a5
Apply suggestions from code review
sjspielman May 13, 2025
e99ce12
updated merged header and add closing paren
sjspielman May 13, 2025
e6ae7e8
caps
sjspielman May 13, 2025
72a0520
Merge branch 'development' into allyhawkins/390-custom-datasets
allyhawkins May 13, 2025
552d530
Update docs/download_options.md
sjspielman May 13, 2025
a6b5e28
options not formats
allyhawkins May 13, 2025
e46afbc
Merge pull request #417 from AlexsLemonade/sjspielman/389-multiplex-o…
sjspielman May 13, 2025
530d90f
download should be detailed
allyhawkins May 13, 2025
e31d874
update remaining spatial sections
allyhawkins May 13, 2025
4840f2c
fix caps while i'm here from dataset -> Dataset
sjspielman May 14, 2025
438b7b4
one data format at a time section
sjspielman May 14, 2025
5f7846c
fix rellink format
sjspielman May 14, 2025
d2f2a89
add link to new faq
sjspielman May 14, 2025
978f8e5
CEll -> cell
sjspielman May 14, 2025
8bb3120
Apply suggestions from code review
allyhawkins May 14, 2025
95f6c13
Apply suggestions from code review
allyhawkins May 14, 2025
4246a78
add some phrasing specifying when spatial is separate
allyhawkins May 14, 2025
84fdd12
is to are
allyhawkins May 14, 2025
f8afabc
Apply suggestions from code review
sjspielman May 14, 2025
a8f1c88
Merge pull request #419 from AlexsLemonade/sjspielman/398-faq-dataset…
sjspielman May 14, 2025
0ba3784
use code block for modalities
allyhawkins May 14, 2025
4600222
fixes to getting_started caught while here
sjspielman May 15, 2025
2663ab6
add no subsetting faq
sjspielman May 15, 2025
88774b0
Add faq on appending rules
sjspielman May 15, 2025
d6d740a
you can edit
sjspielman May 15, 2025
2c50087
Merge pull request #420 from AlexsLemonade/sjspielman/399-why-cant-merge
sjspielman May 15, 2025
71cc08f
Apply suggestions from code review
allyhawkins May 15, 2025
b77c770
Update docs/faq.md
sjspielman May 15, 2025
755ef2d
Add some punctuation
allyhawkins May 15, 2025
728ea67
add a checklist item for todo and stub
sjspielman May 15, 2025
75ab916
Merge pull request #423 from AlexsLemonade/sjspielman/422-todo-releas…
sjspielman May 15, 2025
c5cda3a
Merge branch 'development' into sjspielman/400-project-options-changed
sjspielman May 15, 2025
bfad5b6
Merge remote-tracking branch 'origin/development' into allyhawkins/39…
allyhawkins May 15, 2025
b2d92f2
use lowercase naming for data format
allyhawkins May 15, 2025
4a0dba3
Merge pull request #414 from AlexsLemonade/allyhawkins/390-custom-dat…
allyhawkins May 15, 2025
47db467
Merge remote-tracking branch 'origin/development' into allyhawkins/39…
allyhawkins May 15, 2025
a4d79b3
lowercase modality when talking about folder names
allyhawkins May 15, 2025
6b2c7a3
Merge pull request #418 from AlexsLemonade/allyhawkins/395-update-spa…
allyhawkins May 15, 2025
b2fd6fd
document some missing columns in metadata
sjspielman May 15, 2025
5b8794f
add regeneration section
sjspielman May 15, 2025
920d2de
wording tweak
sjspielman May 15, 2025
e4dd628
confirmed it's also in spatial
sjspielman May 15, 2025
b639422
phrasing to match changelog and remove duplicate sentence
sjspielman May 15, 2025
5397175
it's also in spatial
sjspielman May 15, 2025
c423451
fix link formatting
sjspielman May 15, 2025
80daeb5
Update docs/faq.md
sjspielman May 19, 2025
855fff9
Merge pull request #421 from AlexsLemonade/sjspielman/400-project-opt…
sjspielman May 19, 2025
3f29ff9
Merge branch 'development' into sjspielman/401-different-values
sjspielman May 19, 2025
931b7d5
Apply suggestions from code review
sjspielman May 19, 2025
d1cbf7a
add scpca-nf link and one reword
sjspielman May 19, 2025
30a35a5
use AlexsLemonade/scpca-nf all around in faq.md
sjspielman May 19, 2025
e2548cc
Merge pull request #424 from AlexsLemonade/sjspielman/401-different-v…
sjspielman May 19, 2025
4772eda
removed old files, add new illustrations
dvenprasad May 29, 2025
c7a751a
clean up docs based on images
allyhawkins Jun 4, 2025
3986907
remove multiplexed + portal-wide fix
dvenprasad Jun 5, 2025
0cb50f2
Merge pull request #428 from AlexsLemonade/deepa-add-cart-illustrations
dvenprasad Jun 5, 2025
0966095
Apply suggestions from code review
allyhawkins Jun 5, 2025
55639e3
Merge remote-tracking branch 'origin/development' into allyhawkins/42…
allyhawkins Jun 5, 2025
3886a9b
remaining single-cell_metadata change
allyhawkins Jun 5, 2025
912bfea
bulletize
allyhawkins Jun 5, 2025
5babacb
Merge pull request #429 from AlexsLemonade/allyhawkins/425-cart-docs-…
allyhawkins Jun 5, 2025
63461fa
clean up stubs and todos
allyhawkins Jun 6, 2025
52af311
Merge pull request #431 from AlexsLemonade/allyhawkins/412-clean-up-s…
allyhawkins Jun 9, 2025
aac8ef0
Merge pull request #435 from AlexsLemonade/allyhawkins/merged-changelog
allyhawkins Jul 25, 2025
c1946c1
note zip file name has spaceranger
allyhawkins Nov 24, 2025
7d6601e
new images for spaceranger format
allyhawkins Nov 24, 2025
04424b7
specify spaceranger data format
allyhawkins Nov 24, 2025
42d4acc
Apply suggestions from code review
allyhawkins Nov 24, 2025
858f82d
Merge pull request #465 from AlexsLemonade/allyhawkins/spatial-data-f…
allyhawkins Nov 24, 2025
08728c0
Merge remote-tracking branch 'origin/main' into allyhawkins/sync-main…
allyhawkins Jan 6, 2026
7f8b351
remove the manuscript
allyhawkins Jan 6, 2026
701baee
add my dataset changelog
allyhawkins Jan 6, 2026
ab42178
fix broken link
allyhawkins Jan 6, 2026
47a2180
Apply suggestions from code review
allyhawkins Jan 6, 2026
2f91e05
one more space
allyhawkins Jan 6, 2026
84812bd
Merge pull request #478 from AlexsLemonade/allyhawkins/sync-main-manu…
allyhawkins Jan 6, 2026
f7b4d4f
Apply suggestions from code review
allyhawkins Jan 6, 2026
b3bf8ba
Merge remote-tracking branch 'origin/development' into allyhawkins/my…
allyhawkins Jan 6, 2026
529c712
Merge pull request #479 from AlexsLemonade/allyhawkins/my-dataset-cha…
allyhawkins Jan 6, 2026
0e91536
add release date
allyhawkins Jan 7, 2026
84099fd
Merge pull request #481 from AlexsLemonade/allyhawkins/my-dataset-rel…
allyhawkins Jan 7, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/release-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ assignees: ''
### Preparing for the release
- [ ] Does this release require an update to the CHANGELOG because there will be changes to downloadable files? If so, please create an issue tracking the CHANGELOG update and mark it as blocking this issue.
- [ ] Are all other issues planned for this release resolved? If any issues are unresolved, mark this issue as blocked by those on ZenHub.
- [ ] All `TODO`s and `STUB` links have been filled in with their correct values, or commented out.
- [ ] Optional: If not all changes in `development` are ready to be released, create a feature branch off `main` and cherry pick commits from `development` to that feature branch.
- [ ] File a PR from the `development` branch (or the new feature branch) to the `main` branch. This should include all of the changes that will be associated with the next release.
- [ ] If a CHANGELOG entry was required, add the date to the entry's header as part of this PR.
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/spell-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ on:
branches:
- main
- development
- "the-manuscript"

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
Expand Down
1 change: 1 addition & 0 deletions components/dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ submitter
submitters
Tian
transcriptome
transcriptomic
transcriptomics
TSV
UMAP
Expand Down
23 changes: 18 additions & 5 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,26 @@ As of November 2023, the `CHANGELOG` is a feature of our documentation we'll use
You can find more information about how and when your download was prepared in the following places:

* The date your download was packaged (`Generated on: {date}`) is included at the top of the README in your download.
* The version of the [`AlexsLemonade/scpca-nf`](https://github.com/alexsLemonade/scpca-nf) pipeline used to process data in your download is included in the `workflow_version` column of the `single_cell_metadata.tsv` or `bulk_metadata.tsv` file in your download.
* The version of the [`AlexsLemonade/scpca-nf`](https://github.com/alexsLemonade/scpca-nf) pipeline used to process data in your download is included in the `workflow_version` column of the `single_cell_metadata.tsv`, `bulk_metadata.tsv`, or `spatial_metadata.tsv` file in your download.
For more information about `AlexsLemonade/scpca-nf` versions, please see [the releases page on GitHub](https://github.com/AlexsLemonade/scpca-nf/releases).

<!-------------------------------------------------->
<!-- PUT THE NEW CHANGELOG ENTRY RIGHT BELOW THIS -->
<!-------------------------------------------------->

## 2026.01.08

* Data on the Portal can now be downloaded in three different ways:
* By selecting a {ref}`single project<download_files:project downloads>` to download.
* By creating a {ref}`custom dataset<download_files:custom datasets>` with a selection of projects and/or samples.
Custom datasets are referred to as `My Dataset` on the Portal.
* By choosing one of the {ref}`Portal-wide download options<download_files:portal-wide downloads>`.
* Although the content of the data included in each download has not changed, the download file structures have changed.
See the {ref}`Downloadable Files page for more information<download_files:downloadable files>`.
* A new section of the documentation describing possible {ref}`download options<download_options:download options>` has been added.
* The previously named `single_cell_metadata.tsv` files that are included with each download have been renamed to `single-cell_metadata.tsv`.


## 2025.12.04

All data on the Portal has been updated to include a number of new features.
Expand Down Expand Up @@ -40,11 +53,11 @@ This has now been fixed so that all merged objects have the `cell_id` formatted

## 2025.04.24

* Consensus cell type annotations are now available in all processed `SingleCellExperiment` and `AnnData` objects and merged objects.
* The labels obtained from `SingleR` and `CellAssign` are used to assign an ontology-aware consensus cell type label.
* See our {ref}`documentation on cell type annotation<processing_information:cell type annotation>` to learn more about how consensus cell types are assigned.
* Consensus cell type annotations are now available in all processed `SingleCellExperiment` and `AnnData` objects and merged objects.
* The labels obtained from `SingleR` and `CellAssign` are used to assign an ontology-aware consensus cell type label.
* See our {ref}`documentation on cell type annotation<processing_information:cell type annotation>` to learn more about how consensus cell types are assigned.
* See {ref}`the single-cell gene expression file contents page<sce_file_contents:singlecellexperiment cell metrics>` and {ref}`the merged object file contents page<merged_objects:singlecellexperiment cell metrics>` for more information on obtaining these cell type annotations from the downloaded objects.
* All assays within a merged object are now saved as a sparse matrix (`CsparseMatrix`), whereas previously these assays were saved as a `DelayedArray`.
* All assays within a merged object are now saved as a sparse matrix (`CsparseMatrix`), whereas previously these assays were saved as a `DelayedArray`.

## 2024.11.14

Expand Down
Loading