@abi-software/map-side-bar 1.3.34 → 1.3.35

package/README.md

@@ -1,146 +1,146 @@
-# map-side-bar
-
-[![npm version](https://badge.fury.io/js/%40abi-software%2Fmap-side-bar.svg)](https://badge.fury.io/js/%40abi-software%2Fmap-side-bar)
-
-This project aims to provide a sidebar for searching capability for
-SPARC portal.
-
-## Project installation
-```
-npm i @abi-software/map-side-bar
-```
-
-
-## Project setup
-```
-npm install
-npm run serve
-```
-
-### Compiles and minifies for production
-```
-npm run build-bundle
-```
-
-## How to use
-Include the package in your script.
-```javascript
-import '@abi-software/map-side-bar'
-import '@abi-software/map-side-bar/dist/map-side-bar.css'
-```
-
-#Template
-The code should looks like this
-
-```html
-<SideBar :envVars="envVars"
-         :visible="sideBarVisibility"
-         @actionClick="actionClick">
-</SideBar>
-```
-
-envVars contains environment varibables like so:
-
-```yaml
-{
-  API_LOCATION: 'http://localhost:5000/',
-  ALGOLIA_KEY: 'xxxxxxxxxxxxxxxxxxxxxxxxx',
-  ALGOLIA_ID: 'xxxxx',
-  ALGOLIA_INDEX: 'k-core_dev_published_time_desc',
-}
-```
-
-actionClick event is called when an action button has benn clicked on.
-
-
-## Sidebar Data formats
-### Algolia
-
-Data retrieved from Algolia can be found here:
-https://github.com/ABI-Software/map-sidebar/blob/3310b165489b10901f50a21e5689ef046251dbd9/src/algolia/algolia.js#L136
-
-```
-           [
-            'pennsieve.publishDate',  // optional
-            'pennsieve.updatedAt', // optional
-            'Item.curie', //contains the DOI for the dataset (required)
-            'Item.name', // dataset title (required)
-            'Item.description', // dataset description (required)
-            'objectID', // Pennsieve discover ID (required)
-          ],
-```
-
-### Scicrunch
-
-Data retrieved from scicrunch can be found here:
-https://github.com/nih-sparc/sparc-api/blob/f3444a32964f5340e0ee1f10a08a05839620d098/app/scicrunch_processing_common.py#L25
-
-And mimetypes can be viewed here
-https://github.com/nih-sparc/sparc-api/blob/f3444a32964f5340e0ee1f10a08a05839620d098/app/scicrunch_processing_common.py#L28
-
-```
-ADDITIONAL_LINKS = 'additionalLinks'
-BIOLUCIDA_2D = 'biolucida-2d'
-BIOLUCIDA_3D = 'biolucida-3d'
-COMMON_IMAGES = 'common-images'
-CONTEXT_FILE = 'abi-context-file'
-CSV = 'csv'
-NAME = 'name'
-ORGANS = 'organs'
-PLOT_FILE = 'abi-plot'
-SEGMENTATION_FILES = 'mbf-segmentation'
-SCAFFOLD_DIR = 'abi-scaffold-dir'
-SCAFFOLD_FILE = 'abi-scaffold-metadata-file'
-THUMBNAIL_IMAGE = 'abi-thumbnail'
-SCAFFOLD_VIEW_FILE = 'abi-scaffold-view-file'
-SIMULATION_FILE = 'abi-simulation-file'
-VIDEO = 'video'
-VERSION = 'version'
-README = 'readme'
-TITLE = 'title'
-```
-
-Note: All are optional except for ‘name’ 
-
-### Sidebar input processing
-Sidebar input processing can be viewed here:
-https://github.com/ABI-Software/map-sidebar/blob/3310b165489b10901f50a21e5689ef046251dbd9/src/components/SidebarContent.vue#L318
-
-It is used to keep the code from attempting to access an object property that does not exist
-
-### Context card data format
-All fields are strings:
-```
-{
-  "description": required ,
-  "id": optional,
-  "samples": [ // array required here (can be empty)
-    {
-      "annotation": optional,
-      "description": required,
-      "doi": optional // Doi will be used to link sample to a separate dataset,
-      "heading": required,
-      "id": required,
-      "path": optional // path will be used to link to file location,
-      "view": optional // Will be used to link to “views[i].id”
-    }
-  ],
-  "version": // not currently used,
-  "views": [ // array required here (can be empty)
-    {
-      "annotation": optional,
-      "description": required,
-      "id": requried,
-      "path": required // relative path to the view file, eg "derivative\\Scaffolds\\scaffoldMap_tenial_view.json",
-      "sample": optional // used to link to views to samples
-      "thumbnail": optional // technically optional but it won’t look great
-    } 
-  ]
-}
-```
-
-An example context card file can be viewed here:
-https://drive.google.com/file/d/15NVRBny7WGltpMSRbsgMglXo0xOC3-Q9/view?usp=sharing
-
-
-
+# map-side-bar
+
+[![npm version](https://badge.fury.io/js/%40abi-software%2Fmap-side-bar.svg)](https://badge.fury.io/js/%40abi-software%2Fmap-side-bar)
+
+This project aims to provide a sidebar for searching capability for
+SPARC portal.
+
+## Project installation
+```
+npm i @abi-software/map-side-bar
+```
+
+
+## Project setup
+```
+npm install
+npm run serve
+```
+
+### Compiles and minifies for production
+```
+npm run build-bundle
+```
+
+## How to use
+Include the package in your script.
+```javascript
+import '@abi-software/map-side-bar'
+import '@abi-software/map-side-bar/dist/map-side-bar.css'
+```
+
+#Template
+The code should looks like this
+
+```html
+<SideBar :envVars="envVars"
+         :visible="sideBarVisibility"
+         @actionClick="actionClick">
+</SideBar>
+```
+
+envVars contains environment varibables like so:
+
+```yaml
+{
+  API_LOCATION: 'http://localhost:5000/',
+  ALGOLIA_KEY: 'xxxxxxxxxxxxxxxxxxxxxxxxx',
+  ALGOLIA_ID: 'xxxxx',
+  ALGOLIA_INDEX: 'k-core_dev_published_time_desc',
+}
+```
+
+actionClick event is called when an action button has benn clicked on.
+
+
+## Sidebar Data formats
+### Algolia
+
+Data retrieved from Algolia can be found here:
+https://github.com/ABI-Software/map-sidebar/blob/3310b165489b10901f50a21e5689ef046251dbd9/src/algolia/algolia.js#L136
+
+```
+           [
+            'pennsieve.publishDate',  // optional
+            'pennsieve.updatedAt', // optional
+            'Item.curie', //contains the DOI for the dataset (required)
+            'Item.name', // dataset title (required)
+            'Item.description', // dataset description (required)
+            'objectID', // Pennsieve discover ID (required)
+          ],
+```
+
+### Scicrunch
+
+Data retrieved from scicrunch can be found here:
+https://github.com/nih-sparc/sparc-api/blob/f3444a32964f5340e0ee1f10a08a05839620d098/app/scicrunch_processing_common.py#L25
+
+And mimetypes can be viewed here
+https://github.com/nih-sparc/sparc-api/blob/f3444a32964f5340e0ee1f10a08a05839620d098/app/scicrunch_processing_common.py#L28
+
+```
+ADDITIONAL_LINKS = 'additionalLinks'
+BIOLUCIDA_2D = 'biolucida-2d'
+BIOLUCIDA_3D = 'biolucida-3d'
+COMMON_IMAGES = 'common-images'
+CONTEXT_FILE = 'abi-context-file'
+CSV = 'csv'
+NAME = 'name'
+ORGANS = 'organs'
+PLOT_FILE = 'abi-plot'
+SEGMENTATION_FILES = 'mbf-segmentation'
+SCAFFOLD_DIR = 'abi-scaffold-dir'
+SCAFFOLD_FILE = 'abi-scaffold-metadata-file'
+THUMBNAIL_IMAGE = 'abi-thumbnail'
+SCAFFOLD_VIEW_FILE = 'abi-scaffold-view-file'
+SIMULATION_FILE = 'abi-simulation-file'
+VIDEO = 'video'
+VERSION = 'version'
+README = 'readme'
+TITLE = 'title'
+```
+
+Note: All are optional except for ‘name’ 
+
+### Sidebar input processing
+Sidebar input processing can be viewed here:
+https://github.com/ABI-Software/map-sidebar/blob/3310b165489b10901f50a21e5689ef046251dbd9/src/components/SidebarContent.vue#L318
+
+It is used to keep the code from attempting to access an object property that does not exist
+
+### Context card data format
+All fields are strings:
+```
+{
+  "description": required ,
+  "id": optional,
+  "samples": [ // array required here (can be empty)
+    {
+      "annotation": optional,
+      "description": required,
+      "doi": optional // Doi will be used to link sample to a separate dataset,
+      "heading": required,
+      "id": required,
+      "path": optional // path will be used to link to file location,
+      "view": optional // Will be used to link to “views[i].id”
+    }
+  ],
+  "version": // not currently used,
+  "views": [ // array required here (can be empty)
+    {
+      "annotation": optional,
+      "description": required,
+      "id": requried,
+      "path": required // relative path to the view file, eg "derivative\\Scaffolds\\scaffoldMap_tenial_view.json",
+      "sample": optional // used to link to views to samples
+      "thumbnail": optional // technically optional but it won’t look great
+    } 
+  ]
+}
+```
+
+An example context card file can be viewed here:
+https://drive.google.com/file/d/15NVRBny7WGltpMSRbsgMglXo0xOC3-Q9/view?usp=sharing
+
+
+

package/babel.config.js

@@ -1,14 +1,14 @@
-module.exports = {
-  presets: [
-    '@vue/cli-plugin-babel/preset'
-  ],
-  plugins: [
-    [
-      "component",
-      {
-        libraryName: "element-ui",
-        styleLibraryName: "theme-chalk"
-      }
-    ]
-  ]
-}
+module.exports = {
+  presets: [
+    '@vue/cli-plugin-babel/preset'
+  ],
+  plugins: [
+    [
+      "component",
+      {
+        libraryName: "element-ui",
+        styleLibraryName: "theme-chalk"
+      }
+    ]
+  ]
+}

package/del.json

@@ -0,0 +1,27 @@
+{
+    "description": "Mean luminal pressure (represented by a color field with red as high pressure and blue as low pressure) recorded from the proximal, transverse and distal sections of the pig colon are mapped on the scaffold. \n\nBaseline data was collected for 30min, followed by 15min of stimulation and 30min of post-stimulation.",
+    "heading": "Direct proximal colon stimulation",
+    "id": "sparc.science.context_data",
+    "samples": [
+        {
+            "annotation": "",
+            "description": "Manometry data recorded from pigs under direct proximal colon stimulation.",
+            "doi": "https://doi.org/10.26275/up27-ibcr",
+            "heading": "Proximal direct stimulation samples",
+            "id": "Sample 1",
+            "path": "derivative\\stim_proximal-colon_manometry.csv",
+            "view": "View 1"
+        }
+    ],
+    "version": "0.1.0",
+    "views": [
+        {
+            "annotation": "--",
+            "description": "Sections of pig colon scaffold with mapped manometry data where the data are collected from. ",
+            "id": "View 1",
+            "path": "colon_Layout1_view.json",
+            "sample": "Sample 1",
+            "thumbnail": "derivative\\pig_colon_main_thumbnail.jpeg"
+        }
+    ]
+}

package/delte.json

@@ -0,0 +1,30 @@
+{
+    "description": "This dataset contains single cell scale anatomical map of the rat intrinsic cardiac nervous system (ICNS) across four male and three female hearts. These cell clusters can be seen by the yellow data points on the image as well as spherical markers on the 3D heart scaffold. The dataset provides an integrative framework to visualise the spatial distribution of ICNS across different hearts.",
+    "heading": "Mapped ICN samples",
+    "id": "sparc.science.context_data",
+    "samples": [
+        {
+            "annotation": "",
+            "description": "Spatial location of isolated ICNS mapped onto a generic heart scaffold",
+            "doi": "",
+            "heading": "ICNS from subject M54-8",
+            "id": "Sample 1",
+            "path": "",
+            "view": "View 1",
+            "color": "#FFFF00",
+            "thumbnail": "https://raw.githubusercontent.com/ABI-Software/map-sidebar/main/assets/temp-pics/orange.png"
+        },
+        {
+            "annotation": "",
+            "description": "Spatial location of isolated ICNS mapped onto a generic heart scaffold",
+            "doi": "",
+            "heading": "ICNS from subject M54-5",
+            "id": "Sample 2",
+            "path": "",
+            "view": "View 2",
+            "color": "#FFA500",
+            "thumbnail": "https://raw.githubusercontent.com/ABI-Software/map-sidebar/main/assets/temp-pics/teal.png"
+        }
+    ],
+    "version": "0.1.0"
+}