Merge pull request #260 from nfdi4plants/docu

Miniscule table documentation script in javascript

README.md

@@ -5,8 +5,9 @@ and __JavaScript__! ❤️
 
 | Version | Downloads |
 | :--------|-----------:|
-|![Nuget (with prereleases)](https://img.shields.io/nuget/vpre/ARCtrl?logo=nuget&color=%234fb3d9)|![Nuget](https://img.shields.io/nuget/dt/ARCtrl?color=%234FB3D9)|
-|![npm (scoped with tag)](https://img.shields.io/npm/v/%40nfdi4plants/arctrl/next?logo=npm&color=%234fb3d9)|![npm](https://img.shields.io/npm/dt/%40nfdi4plants%2Farctrl?color=%234fb3d9)|
+|<a href="https://www.nuget.org/packages/ARCtrl/"><img alt="Nuget" src="https://img.shields.io/nuget/vpre/ARCtrl?logo=nuget&color=%234fb3d9"></a>|<a href="https://www.nuget.org/packages/ARCtrl/"><img alt="Nuget" src="https://img.shields.io/nuget/dt/ARCtrl?color=%234FB3D9"></a>|
+|<a href="https://www.npmjs.com/package/@nfdi4plants/arctrl"><img alt="NPM" src="https://img.shields.io/npm/v/%40nfdi4plants/arctrl/next?logo=npm&color=%234fb3d9"></a>|<a href="https://www.npmjs.com/package/@nfdi4plants/arctrl"><img alt="NPM" src="https://img.shields.io/npm/dt/%40nfdi4plants%2Farctrl?color=%234fb3d9"></a>|
+
 
 ## Install
 

docs/scripts_js/Tables.js

@@ -0,0 +1,50 @@
+// This script presents the most straightforward way to create and write an assay file filled with tables
+// In principle, there are three steps
+// 1. Create and manipulate object in datamodel
+// 2. Transform object to generic spreadsheet
+// 3. Write spreadsheet to xlsx file (or bytes)
+
+// Import ARCtrl
+import * as arctrl from "@nfdi4plants/arctrl"
+// Alternative import
+// import { 
+    //     Comment$ as Comment, OntologyAnnotation, Person, Publication, 
+    //     IOType, CompositeHeader, CompositeCell, CompositeColumn, ArcTable, 
+    //     ArcAssay, ArcStudy, ArcInvestigation,
+    //     Template, Organisation, Templates, JsWeb,
+    //     ARC } from "@nfdi4plants/arctrl";
+
+// Import ARCtrl Assay to Spreadsheet transformation
+import {toFsWorkbook,fromFsWorkbook} from "@nfdi4plants/arctrl/ISA/ISA.Spreadsheet/ArcAssay.js"
+
+// Import Spreadsheet to XLSX reader/writer
+import {Xlsx} from "@fslab/fsspreadsheet";
+
+// -------- 1. Create and manipulate object in datamodel ----------
+
+// Create assay
+const myAssay = arctrl.ArcAssay.init("MyAssay");
+
+// Create annotation table
+const growth = arctrl.ArcTable.init("Growth");
+
+// Add input column with one value to table
+growth.AddColumn(new arctrl.CompositeHeader(11, [new arctrl.IOType(0, [])]), [arctrl.CompositeCell.createFreeText("Input1")]);
+
+// Add characteristic column with one value
+const oa_species = arctrl.OntologyAnnotation.fromString("species", "GO", "GO:0123456");
+const oa_chlamy = arctrl.OntologyAnnotation.fromString("Chlamy", "NCBI", "NCBI:0123456");
+growth.AddColumn(new arctrl.CompositeHeader(1, [oa_species]), [arctrl.CompositeCell.createTerm(oa_chlamy)]);
+
+// Add table to assay
+myAssay.AddTable(growth);
+
+// -------- 2. Transform object to generic spreadsheet ----------
+let spreadsheet = toFsWorkbook(myAssay);
+
+// -------- 3. Write spreadsheet to xlsx file (or bytes) ----------
+const outPath = "./myFile.xlsx";
+
+console.log(Xlsx.toBytes(spreadsheet));
+
+await Xlsx.toFile(outPath,spreadsheet);

docs/scripts_js/package.json

@@ -9,7 +9,7 @@
   "author": "Kevin Frey",
   "license": "MIT",
   "dependencies": {
-    "@nfdi4plants/arctrl": "^1.0.0-alpha6",
-    "fsspreadsheet": "^4.0.0-alpha2"
+    "@nfdi4plants/arctrl": "^1.0.0-beta.7",
+    "@fslab/fsspreadsheet": "^5.0.0"
   }
 }