Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prep docs for release of portal wide metadata #320

Merged
merged 4 commits into from
Jul 8, 2024
Merged

Prep docs for release of portal wide metadata #320

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2f2f2e5
uncomment portal wide description
allyhawkins Jul 8, 2024
b692597
add changelog for portal wide
allyhawkins Jul 8, 2024
1c86c8b
Apply suggestions from code review
allyhawkins Jul 8, 2024
c61a0a0
reword metadata description
allyhawkins Jul 8, 2024
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
5 changes: 5 additions & 0 deletions docs/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ For more information about `AlexsLemonade/scpca-nf` versions, please see [the re
<!-- PUT THE NEW CHANGELOG ENTRY RIGHT BELOW THIS -->
<!-------------------------------------------------->

## PLACEHOLDER FOR PORTAL WIDE METADATA

* Metadata for all samples from all projects on the Portal can now be downloaded as one tab-separated values file.
allyhawkins marked this conversation as resolved.
Show resolved Hide resolved
* For more information on what to expect in the metadata file, see the {ref}`metadata section of the Downloadable files page <download_files:metadata`.

## 2024.06.20

* Metadata for all samples in a specified project can now be downloaded as a tab-separated values file.
Expand Down
4 changes: 2 additions & 2 deletions docs/download_files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,9 +162,9 @@ This file will contain fields equivalent to those found in the `single_cell_meta
Metadata for all samples on the Portal is available to download separately from gene expression data downloads.
Each project page has an option to download metadata for all of its samples as a single zip file containing the `metadata.tsv` file and a `README.md` file.
Project-specific metadata will contain all columns listed in [the above table](#metadata) and any additional project-specific columns, such as treatment or outcome.
<!--

Additionally, the metadata for all samples on the Portal is available and contains the metadata for all samples available on the Portal.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Additionally, the metadata for all samples on the Portal is available and contains the metadata for all samples available on the Portal.
Additionally, the metadata for all samples on the Portal is available for download as a TSV file and contains the metadata for all samples available on the Portal.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oof this sentence was a lot of repetition, so I reworded it in c61a0a0.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, c61a0a0 is better!

The Portal-wide metadata will contain all columns listed in [the above table](#metadata).-->
The Portal-wide metadata will contain all columns listed in [the above table](#metadata).

## Multiplexed sample libraries

Expand Down
Loading