Prep docs for release of portal wide metadata #320
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sjspielman
approved these changes
Jul 8, 2024
docs/download_files.md
Outdated
| @@ -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. | |||
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
Oof this sentence was a lot of repetition, so I reworded it in c61a0a0.
Co-authored-by: Stephanie Spielman <[email protected]>
This was referenced Jul 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #318
Here I uncommented out the section of the docs that described the portal wide metadata and added a changelog entry. I kept the changelog entry pretty brief, but let me know if I should expand any more there?
Before we actually release these docs we will need to add a date to the changelog.