From 85c1b6957e8735b38c1a64d532e61c12614777a5 Mon Sep 17 00:00:00 2001 From: Sidney Bell Date: Fri, 22 Nov 2019 14:53:30 -0800 Subject: [PATCH] Final annotations notes --- docs/posts/annotations.md | 10 +++++++--- docs/posts/launch.md | 2 +- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/posts/annotations.md b/docs/posts/annotations.md index edc9dc16..81147899 100644 --- a/docs/posts/annotations.md +++ b/docs/posts/annotations.md @@ -8,18 +8,19 @@ description: Creating annotations We are _piloting_ a new feature in cellxgene that enables users to create and edit categorical annotations within the app. We'd love for you to try it out and [give us feedback](contact)! -## Quick start for annotations +## Quick start for annotations (RECOMMENDED for most users) You can enable this experimental feature like so: `cellxgene launch mydata.h5ad --experimental-annotations` -To preserve data provenance, **`cellxgene` does not alter the input h5ad file**. -Rather, newly-created annotations are saved in a specified CSV file: +To preserve data provenance, **`cellxgene` does not alter the input h5ad file**. Rather, newly-created annotations are saved in a specified CSV file: - You will be prompted to enter a name for your annotations the first time you create a new category. - We also assign a unique identifier in the form of an 8-character suffix, `########`; this helps cellxgene identify your file to avoid overwriting your work. - Any annotations you create in the application will be autosaved in `cwd/name-########.csv`, where `cwd` is your current working directory (i.e., the directory you were in when you started cellxgene). +If you quit cellxgene and relaunch it with the same h5ad, we will check for this annotations csv and load it in editable mode alongside. + ## Data management ### Loading, editing and updating existing draft annotations @@ -74,6 +75,9 @@ anndata.obs = anndata.obs.join(new_annotations) ### How do I know my annotations are saved? `cellxgene` autosaves any changes made to your annotations every 3 seconds. +### I think I deleted my annotations! Oh noes! +Not to worry! We save the last 10 versions of your annotations in `annotations-directory/NAME-backups/` + ### What about creating continuous annotations? Continuous metadata is important! However, these values (e.g., pseudotime) are the result of statistical analyses that are beyond cellxgene's visualization- and exploration-focused scope. We do, of course, provide visualization of continuous metadata values computed elsewhere and stored in `anndata.obs`. diff --git a/docs/posts/launch.md b/docs/posts/launch.md index 9792cb4c..970e6aa8 100644 --- a/docs/posts/launch.md +++ b/docs/posts/launch.md @@ -46,7 +46,7 @@ cellxgene launch s3://mybucket.s3-us-west-2.amazonaws.com/mydata.h5ad `--open` automatically opens the web browser after launching (caveat: only works on some operating systems). -`--experimental-label-file` enables an experimental feature to allow users to create new categorical annotations in the application. These newly-created annotations are saved in the specified CSV file. If the specified file already exists, the previously-contained annotations will be loaded as mutable (changeable) values and the CSV will be updated (overwritten) with any edits made. If the file does not exist, it will be created. See [the annotations documentation](annotations) for more details. +`--experimental-annotations`, `--experimental-annotations-file` & `--experimental-annotations-output-dir` all have to do with an experimental feature to allow users to create new categorical annotations in the application. We have a [whole separate page](annotations) about their usage! :) `--diffexp-lfc-cutoff` as explained [in the methods](methods), genes are only returned in differential expression if the effect size is above the specified threshold for log fold change. Defaults to 0.01.