diff --git a/docs/Sitemap-Members.md b/docs/Sitemap-Members.md new file mode 100644 index 0000000..bdfcd1c --- /dev/null +++ b/docs/Sitemap-Members.md @@ -0,0 +1,54 @@ +
+ × + Developers + Data Submitters + Consortium Members +
+ + +open + + + +
+ +# Developers + +
+ Developer Tools (linked from the HuBMAP Consortium website): +
+ + - HuBMAP Application-specific APIs (**Not intended for use by external developers or other external users**): + - Ingest API: Supports writing data and metadata to HuBMAP, used by both TMCs and the HIVE. Links to the SmartAPI site where this API is registered as well as documentation for the API. + - UUID API: Supports donor and tissue sample registration, data submission, and collection of provenance information via the Ingest UI. Links to GitHub documentation for this API. + - Ontology (UBKG) API: Accesses an instance of a [neo4j] Unified Biomedical Knowledge Graph (UBKG). + - This UBKG links infomation from a variety of biomedical vocabulary systems. + - The HuBMAP UBKG instance includes HuBMAP’s application ontology that represents the HuBMAP operational model. + - Links to the SmartAPI site where this API is registered as well as documentation for the API. + +# Data Submitters + - Data Submission Guide: Documents the key steps for TMCs, Assay teams, and others who upload data to the HuBMAP. + - Metadata/data schemas: HuBMAP metadata documentation and submission specifications. + - See the HuBMAP Data Upload Guidelines for the latest assay metadata options and specifications. + - Metadata Spreadsheet Validator: Use this tool to validate your metadata spreadsheet (template). + - Help documentation for the Metadata Spreadsheet Validator. + - HuBMAP Microscope Metadata entry form: Submit Microscopy Metadata in compliance with the NBO-Q metadata model. + - HuBMAP Microscope Hardware Collection: List of Microscopy Metadata collected to date. + +# Consortium Members + - HuBMAP Member Portal: Find information about how to navigate the consortium, including the calendar, member directory, etc. + - SOPs + - Governance: The HuBMAP Steering Committee and Working Groups. + - HuBMAP Consortium Google Drive: A shared resource. + - Document Management Guide: For the HuBMAP Consortium Google Drive. + - HuBMAP Calendar: A web calendar that combines all shared, internal Consortium events. + - Using Google Groups with Google Calendar + - other Resources +
diff --git a/docs/content.html b/docs/content.html new file mode 100644 index 0000000..092200d --- /dev/null +++ b/docs/content.html @@ -0,0 +1,88 @@ + + + +HuBMAP Member Sitemap + + +

HuBMAP Documentation Sitemap

+ +

Developers

+

Developer Tools

+Developers may need access to these tools for specific development work: + + + +

Application-specific APIs

+These HuBMAP APIs are not intended for use by external developers or other external users. + + +

Data Submitters

+ + +

General Links

+ + + + + diff --git a/docs/content2.html b/docs/content2.html new file mode 100644 index 0000000..ef37fca --- /dev/null +++ b/docs/content2.html @@ -0,0 +1,29 @@ + + + +HuBMAP Non-Member Sitemap + + +

HuBMAP Documentation Sitemap

+ +

General Links

+ + + + + diff --git a/docs/doc-sitemap-draft.md b/docs/doc-sitemap-draft.md new file mode 100644 index 0000000..a5e8e8d --- /dev/null +++ b/docs/doc-sitemap-draft.md @@ -0,0 +1,104 @@ +## External viewers +### HuBMAP Data +- Developers: + - Programmatic access to data / metadata via APIs or Tools + - APIs to find metadata / data: + - Search API: The HuBMAP Search API is a thin wrapper of the Elasticsearch API. + - It handles data indexing and reindexing into the backend Elasticsearch. + - It accepts the search query and passes through to the Elasticsearch with data access security check. + - Entity API: The Entity API returns information about HuBMAP data entities. + - Generally, a donor and organ are _required_ in the provenance hierarchy where tissue samples (such as blocks and samples) can be organized based on several different tissue sample types. + - Tools to get data without going to the Portal + - Data and metadata structures (Link to Jes W.’s Cohesive [Metadata] Doc stuff?) + - Examples: docs, commands, (Jupyter notebooks) +- Other Stakeholders: + - View / Access / Download data (via the Portal) + - HuBMAP FAQ: Frequently Asked Questions about HuBMAP Data, Tools, and related topics. + - About HuBMAP: Policies & Procedures, DUA, Protected Data & Access, Citing HuBMAP Data, Funding & Contact info. + - **Training Materials:** Biomedical technologies such as single-cell and spatial approaches are not common at all institutions of higher education. Significant barriers towards making effective use of such data include the lack of available training. + - HuBMAP has created several self-paced training modules to fill this gap. These modules... + - Focus on introducing HuBMAP, including technologies & assays used by HuBMAP, HuBMAP metadata, and example use cases. + - Demonstrate how to include HuBMAP data in research projects, graduate student theses, and classroom teaching. +
+ See Self-paced Training Modules + +
+ + - HuBMAP Publications: See more than 330 featured publications to learn how HuBMAP tools and data are advancing discovery. + +### HuBMAP Tools and documentation links +- HRA Tools: + - Human Reference Atlas (HRA): a comprehensive, high-resolution, three-dimensional atlas of all the cells in a healthy human body. + - Watch a short video introduction or check out the latest release notes for the HRA. +
+ See additional Tools available from the HRA... +
+- Azimuth: A web application that uses an annotated reference dataset to automate the processing, analysis, and interpretation of new single-cell sequencing experiments. + - This page provides Query references, a general workflow, FAQ, and tips for Preprocessing, Mapping, and other topics. +- FUSION: Functional Unit State Identification and Navigation with WSI - An interactive interface to view spatial transcriptomics data integrated with histopathology, driven by AI. This site contains multiple tutorials and other helpful features. +- Vitessce: Visual integration tool for exploration of spatial single cell experiments. + - Vitessce Documentation + - Vitessce Tutorials +- Intro/primer to using HuBMAP data analysis tools + - examples +- Reproducing HuBMAP workflows (Y3 effort) + - Using APIs to get information about workflows +- HuBMAP (Data Portal) Workspaces: Explore public HuBMAP data and user-provided data using Python and R in a Jupyter Lab environment. + - Workspaces Tutorials: Learn how to interactively analyze HuBMAP datasets by uploading them in a JupyterLab environment. + +### HuBMAP APIs +- HuBMAP APIs: Available as RESTful web services, these APIs support data ingest, querying, and delivery of metadata. +- Documentation for HuBMAP APIs at Smart APIs. Click the Details button for more information and documentation. +- Links to use-case-specific API usage (e.g. using data and tools) linked to Data and Tools pages. + +## Internal viewers +- Internal developers +
+ Developer Tools (linked from the HuBMAP Consortium website): +
+ + - HuBMAP Application-specific APIs (**Not intended for use by external developers or other external users**): + - Ingest API: Supports writing data and metadata to HuBMAP, used by both TMCs and the HIVE. Links to the SmartAPI site where this API is registered as well as documentation for the API. + - UUID API: Supports donor and tissue sample registration, data submission, and collection of provenance information via the Ingest UI. Links to GitHub documentation for this API. + - Ontology (UBKG) API: Accesses an instance of a [neo4j] Unified Biomedical Knowledge Graph (UBKG). + - This UBKG links infomation from a variety of biomedical vocabulary systems. + - The HuBMAP UBKG instance includes HuBMAP’s application ontology that represents the HuBMAP operational model. + - Links to the SmartAPI site where this API is registered as well as documentation for the API. +- Data submitters + - Data Submission Guide: Documents the key steps for TMCs, Assay teams, and others who upload data to the HuBMAP. + - Metadata/data schemas: HuBMAP metadata documentation and submission specifications. + - See the HuBMAP Data Upload Guidelines for the latest assay metadata options and specifications. + - Metadata Spreadsheet Validator: Use this tool to validate your metadata spreadsheet (template). + - Help documentation for the Metadata Spreadsheet Validator. + - HuBMAP Microscope Metadata entry form: Submit Microscopy Metadata in compliance with the NBO-Q metadata model. + - HuBMAP Microscope Hardware Collection: List of Microscopy Metadata collected to date. +- General Consortium members + - HuBMAP Member Portal: Find information about how to navigate the consortium, including the calendar, member directory, etc. + - SOPs + - Governance: The HuBMAP Steering Committee and Working Groups. + - HuBMAP Consortium Google Drive: A shared resource. + - Document Management Guide: For the HuBMAP Consortium Google Drive. + - HuBMAP Calendar: A web calendar that combines all shared, internal Consortium events. + - Using Google Groups with Google Calendar + - other Resources diff --git a/docs/down-arrow1.gif b/docs/down-arrow1.gif new file mode 100644 index 0000000..d84a0c9 Binary files /dev/null and b/docs/down-arrow1.gif differ diff --git a/docs/left-menu.html b/docs/left-menu.html new file mode 100644 index 0000000..03d088a --- /dev/null +++ b/docs/left-menu.html @@ -0,0 +1,25 @@ + + +HuBMAP Doc Sitemap Menu + + + +

Table of Contents

+ + + + \ No newline at end of file diff --git a/docs/microscopy-metadata-links.md b/docs/microscopy-metadata-links.md new file mode 100644 index 0000000..b7b3621 --- /dev/null +++ b/docs/microscopy-metadata-links.md @@ -0,0 +1,54 @@ +## Microscopy Metadata Captured to date... (as of 11-06-2023) +The table below is a much smaller subset of the [HuBMAP Microscope Hardware Collection Roll Call](https://docs.google.com/spreadsheets/d/1Ju1_mvqTk1B8I8Ot6EKFKZuQbwkJy4NwzVgwoITWWYw/edit?gid=0#gid=0) sheet.
See that linked sheet for more detailed information about each instrument and other related details. + +|Group | Instrument |Assay Category| JSON File? | +| :---: |------------| :------: | :------: | +| TMC-JHU |Hamamatsu NanoZoomer S210 slide scanner|Stained
Microscopy|[JSON](https://drive.google.com/file/d/1rH2biY_14COZDmphW_Iz1kR3NrIjPOZA/view?usp=drive_link)
Placeholder| +|TMC-WUSTL|Akoya - Phenocycler-Fusion 1.0 (v1.0.5 software)|CODEX|[JSON](https://drive.google.com/file/d/1FcrwZLAgWLyIJ0jd0VtD1ZYLvnpOlkF3/view?usp=share_link)| +|▽|Akoya - Phenocycler-Fusion 1.0 (v1.0.8 software)|▽|[JSON](https://drive.google.com/file/d/1yE4yz7cH_-PNkoeQzY6AmjNdmKWHIqeJ/view?usp=share_link)| +|▽|Akoya - Phenocycler-Fusion 1.0 (v2beta software)|▽|[JSON](https://drive.google.com/file/d/1Sn0KJzkNP56sWtKNuGI61BpfNh467-HL/view?usp=share_link)| +|▽|Akoya - Phenocycler-Fusion 1.0 (v2.1.0 software)|▽|[JSON](https://drive.google.com/file/d/1ZG0FGfX0vHNW-nzsXnVUYKp0-xmChUe4/view?usp=share_link)| +|▽|Keyence BZ-X800 microscope|VISIUM
(workflow 1 + 2)|[JSON](https://drive.google.com/file/d/1jZ7LK7CkbVeSTbzrwtuQpL1ZhqJWLBYv/view?usp=drive_link)
Incomplete| +|▽|10x Genomics Visium CytAssist|VISIUM
(workflow 2)|[JSON](https://drive.google.com/file/d/1A5FBLffTfdq9PXyE_5p855mbk7TZU1mz/view?usp=drive_link)
Placeholder| +|▽|Zeiss Light Sheet 7|Lightsheet|Not Required| +|TMC-UCSD (Pregnant
female reproductive)|Akoya - Phenocycler-Fusion 1.0|CODEX|[JSON](https://drive.google.com/file/d/1vJ3FOVJKwRS1a-IxkYjsWOzuDxUj6SAh/view?usp=drive_link)| +|▽|Hamamatsu NanoZoomer 2.0-HT slide scanner|Stained
Microscopy|[JSON](https://drive.google.com/file/d/1x0yXKRk1SUxZmB6CkjjQTlNhTNukszpG/view?usp=share_link)
Placeholder| +|▽|Hamamatsu NanoZoomer-SQ slide scanner|VISIUM & Stained
Microscopy|[JSON](https://drive.google.com/file/d/1Q-F_puhGsxFwa-pRQFYEVtw7bbS8AUG_/view?usp=drive_link)
Placeholder| +|▽|Motic EasyScan One|▽|[JSON](https://drive.google.com/file/d/1LvHPD7SktNrA0qEHndHKoozadnv_ehhK/view?usp=drive_link)
Incomplete| +|▽|Leica DM6-B microscope|▽|[JSON](https://drive.google.com/file/d/11hp8a0mztmimGPG8eZb1N9HkX5uPaXV6/view?usp=drive_link)
Incomplete| +|▽|10x Genomics Visium CytAssist|VISIUM|[JSON](https://drive.google.com/file/d/15Y5l2CCg0JSWdaZQQpZdHaegByS4DhWZ/view?usp=drive_link)
Placeholder| +|▽|nanoString GeoMx Digital Spatial Profiler|GeoMx (NGS)| | +|TMC-UPenn|Zeiss Axio Observer 7 microscope|VISIUM & Stained
Microscopy|[JSON](https://drive.google.com/file/d/1Gn0L0IvnD7M9AKhb7hP1oKeMmPFl1Ewh/view?usp=drive_link)| +|▽|Akoya - Phenocycler-Fusion 2.0|CODEX|[JSON](https://drive.google.com/file/d/1rXNz1KhheY2seF7ssOlR-QGd8oFRpjlH/view?usp=drive_link)| +|TMC-BIDMC|Akoya - Phenocycler-Fusion 1.0 (v2.0.0 software)| ▽|[JSON](https://drive.google.com/file/d/1cLA5mHMm-SDqLLqYsFD0bYk32N-8tNMF/view?usp=drive_link)| +|▽|     ▽|▽|[JSON](https://drive.google.com/file/d/1GAe8e0bss1lMx1aluh7EIjQUlkMcfxZa/view?usp=drive_link)| +|TMC-CHOP (Heart)|Akoya - Phenocycler-Fusion 1.0|▽|[JSON](https://drive.google.com/file/d/1dT-LSvuW6mpX4csVyDPZDz3_EKK3XPc_/view?usp=drive_link)| +|RTI-GEscd|GE Healthcare IN Cell Analyzer 2200|MxIF|[JSON](https://drive.google.com/file/d/1UUbxWYAapHiongJ6CZtrdBlA5NXHtiEk/view?usp=drive_link)
Incomplete| +|TMC-URMC|Akoya - Phenocycler-Fusion 1.0|CODEX|[JSON](https://drive.google.com/file/d/1iU5h_VcCSNoCS5aEIkaBc1fD9ykA_urW/view?usp=drive_link)| +|HIVE-TC-CMU|No Instrument - Example Image Metadata only|NA|[Example Only](https://drive.google.com/open?id=1lQPSgxcmibwf0-jdV1YvMmb2T3_8q1bn&usp=drive_fs)| +|NA|Akoya CODEX 1st Generation (Keyence BZ-800)|CODEX|[Template](https://drive.google.com/file/d/1yT56JLJ2Lzah_nVS7AnVa4OO5ppQma4w/view?usp=drive_link)| +|▽|Akoya CODEX 1st Generation (Zeiss Axio Observer 7)|▽|[Template](https://drive.google.com/file/d/1DX4RD6o1yS0MIgqP6XeKiCl2FwhyZ0ep/view?usp=drive_link)| +|TMC-DUSM (SenNet)|Zeiss_Axio-Scan.Z1 microscope|VISIUM & Stained
Microscopy|[JSON](https://drive.google.com/file/d/1O35LEFM7Xj6upY6BeNM0IHr2eiqMaHT6/view?usp=drive_link)| +|▽|10x Genomics Visium CytAssist|VISIUM|[JSON](https://drive.google.com/file/d/174RxJRDxLDE7Oos5Nxirkv4575KLdP5m/view?usp=drive_link)
Placeholder| +|TMC-UF|nanoString GeoMx Digital Spatial Profiler|GeoMx (NGS)|[JSON](https://drive.google.com/file/d/1l84P4l0OFykvLnpZMFk8AdySvKj0lsVh/view?usp=drive_link)
Placeholder| +|TMC-Vanderbilt (Kidney)|    ▽|▽|[JSON](https://drive.google.com/file/d/1Q9AhAPGx8Rfj3B53F7eXG5GNcUN3Y-C2/view?usp=drive_link)
Placeholder| +|▽|Zeiss_Axio-Scan.Z1 microscope|Autofluorescence
Microscopy (AF)|[JSON](https://drive.google.com/file/d/1x4MoX_iFAra0W7PIgMHMeV1i0KEqXsKe/view?usp=drive_link)| +|TMC-Stanford (Intestine)|CODEX 1st Generation (Keyence BZ-X700)|Histology + CODEX|[JSON](https://drive.google.com/file/d/15cDk2Pgts8vaT_6hwoI2KSlmXu4HIyqK/view?usp=drive_link)| +|▽|Akoya - Phenocycler-Fusion 2.0|CODEX|[JSON](https://drive.google.com/file/d/1uYyH2vMEuuC_GrF_9Mi49C4dIZ-g-0hq/view?usp=drive_link)| +|▽|10x Genomics Xenium Analyzer|XENIUM|[JSON](https://drive.google.com/file/d/10mnpTWG6Ji9VUQ-PrN4EZbKdKC9YqtFn/view?usp=drive_link)
Placeholder| + +    ( ▽ - Indicates that the item in the cell _immediately_ above is repeated in the current cell. ) + +### How to Use this Table (above...) +- Find an instrument in the table similar (closest) to what you are using +- Download the JSON file from the table above for that instrument +- JSON files that are _placeholders_ or _incomplete_ are noted. JSON files without a notation can be considered _complete_. +- Use the downloaded JSON as a template, filling out the specifics for your instrument +- Upload the updated JSON file to HuBMAP along with your other Metadata + +### Some Helpful Links related to Microscopy Metadata +- [Micro-Meta BETA](https://data.4dnucleome.org/tools/micro-meta-app) from 4D Nucleome +- [Micro-Meta App](https://wu-bimac.github.io/MicroMetaApp.github.io/) on GitHub +- Read the [paper](https://www.nature.com/articles/s41592-021-01315-z) about the Micro Meta app in _Nature_. +- 4DN-BINA-OME [(NBO) Microscopy Metadata Specifications](https://fairsharing.org/4747) +- [NBO Microscopy Metadata Specifications](https://github.com/WU-BIMAC/NBOMicroscopyMetadataSpecs) on GitHub