@platforma-open/milaboratories.top-antibodies.workflow 1.8.1 → 1.9.0

package/.turbo/turbo-build.log

@@ -1,6 +1,6 @@
  WARN  Issue while reading "/home/runner/work/antibody-tcr-lead-selection/antibody-tcr-lead-selection/.npmrc". Failed to replace env in config: ${NPMJS_TOKEN}
 
-> @platforma-open/milaboratories.top-antibodies.workflow@1.8.1 build /home/runner/work/antibody-tcr-lead-selection/antibody-tcr-lead-selection/workflow
+> @platforma-open/milaboratories.top-antibodies.workflow@1.9.0 build /home/runner/work/antibody-tcr-lead-selection/antibody-tcr-lead-selection/workflow
 > rm -rf dist && pl-tengo check && pl-tengo build
 
 Processing "src/filter-and-sample.tpl.tengo"...

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @platforma-open/milaboratories.top-antibodies.workflow
 
+## 1.9.0
+
+### Minor Changes
+
+- b499ab2: Add rank column
+
+### Patch Changes
+
+- Updated dependencies [b499ab2]
+  - @platforma-open/milaboratories.top-antibodies.sample-clonotypes@1.2.0
+
+## 1.8.2
+
+### Patch Changes
+
+- f25cad6: Fix slices typo in main workflow
+
 ## 1.8.1
 
 ### Patch Changes

package/dist/tengo/lib/sampled-cols-conv.lib.tengo

@@ -1,14 +1,7 @@
 ll := import("@platforma-sdk/workflow-tengo:ll")
 
-getColumns := func(datasetSpec) {
-  return {
-    axes: [
-      {
-        column: "clonotypeKey",
-        spec: datasetSpec.axesSpec[1]
-      }],
-    columns: [
-      {
+getColumns := func(datasetSpec, addRanking) {
+  columns := [{
         column: "top",
         id: "link",
         allowNA: false,
@@ -22,8 +15,31 @@ getColumns := func(datasetSpec) {
             "pl7.app/isSubset": "true"
           }
         }
-      }
-    ],
+      }]
+  if addRanking {
+    columns = columns + [{
+        column: "ranked_order",
+        spec: {
+          name: "pl7.app/vdj/ranking-order",
+          valueType: "Int",
+          domain: {},
+          annotations: {
+            "pl7.app/label": "Rank",
+            "pl7.app/table/visibility": "optional",
+            "pl7.app/isSubset": "true"
+          }
+        }
+      }]
+  }
+
+
+  return {
+    axes: [
+      {
+        column: "clonotypeKey",
+        spec: datasetSpec.axesSpec[1]
+      }],
+    columns: columns,
     storageFormat: "Binary",
     partitionKeyLength: 0
   }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@platforma-open/milaboratories.top-antibodies.workflow",
-  "version": "1.8.1",
+  "version": "1.9.0",
   "type": "module",
   "description": "Block Workflow",
   "dependencies": {
     "@platforma-sdk/workflow-tengo": "^4.9.2",
-    "@platforma-open/milaboratories.top-antibodies.sample-clonotypes": "1.1.0",
+    "@platforma-open/milaboratories.top-antibodies.sample-clonotypes": "1.2.0",
     "@platforma-open/milaboratories.top-antibodies.spectratype": "1.4.0",
     "@platforma-open/milaboratories.top-antibodies.umap": "1.0.3"
   },

package/src/filter-and-sample.tpl.tengo

@@ -1,4 +1,4 @@
-// Template for clonotype filtering
+// Template for clonotype filtering and sampling
 self := import("@platforma-sdk/workflow-tengo:tpl")
 exec := import("@platforma-sdk/workflow-tengo:exec")
 assets := import("@platforma-sdk/workflow-tengo:assets")
@@ -39,7 +39,7 @@ self.body(func(inputs) {
     filteredClonotypesCsv := filterResult.getFile("filteredClonotypes.csv")
 
     // Store outputs 
-    sampledColsParams := sampledColsConv.getColumns(datasetSpec)
+    sampledColsParams := sampledColsConv.getColumns(datasetSpec, false) // No ranking column
     filteredClonotypesPf := xsv.importFile(filteredClonotypesCsv, "csv", sampledColsParams,
                                         {cpu: 1, mem: "16GiB"})
 
@@ -69,6 +69,7 @@ self.body(func(inputs) {
 		finalClonotypesCsv = sampleClones.getFile("sampledClonotypes_top.csv")
 		
 		// Store outputs 
+        sampledColsParams := sampledColsConv.getColumns(datasetSpec, true) // Add ranking column
 		sampledColumnsPf := xsv.importFile(finalClonotypesCsv, "csv", sampledColsParams,
 											{cpu: 1, mem: "16GiB"})
 		outputs["sampledRows"] = pframes.exportFrame(sampledColumnsPf)

package/src/main.tpl.tengo

@@ -4,7 +4,6 @@ exec := import("@platforma-sdk/workflow-tengo:exec")
 assets:= import("@platforma-sdk/workflow-tengo:assets")
 xsv := import("@platforma-sdk/workflow-tengo:pframes.xsv")
 pframes := import("@platforma-sdk/workflow-tengo:pframes")
-sampledColsConv := import(":sampled-cols-conv")
 spectratypeConv := import(":pf-spectratype-conv")
 vjUsageConv := import(":pf-vj-usage-conv")
 slices := import("@platforma-sdk/workflow-tengo:slices")
@@ -88,23 +87,23 @@ wf.body(func(args) {
 	// Input arguments
 	columns := args.columns
 	datasetSpec := columns.getSpec(args.inputAnchor)
-	
 	topClonotypes := args.topClonotypes
 
-	// Needed conditional variables
+	// Needed conditional variable
 	isSingleCell := datasetSpec.axesSpec[1].name == "pl7.app/vdj/scClonotypeKey"
 	
-	// output containers 
+	// Output container
 	outputs := {}
 
-	// Get filtered clonotypes from prerun
-	// Build clonotype table
+	// Build clonotype table csv for filtering script
 	cloneTable := pframes.csvFileBuilder() 
 	cloneTable.setAxisHeader(datasetSpec.axesSpec[1].name, "clonotypeKey")
 
-	// Add Filters to table
-	addedAxes := []
-	filterMap := {}
+	// Add filter columns to table
+	// Filter structure {id: UI id, value: AnchoredColumnId, filter: Filter criteria, isExpanded: boolean (UI state)}
+	// AnchoredColumnId {anchorRef: PlRef, anchorName: string, column: SUniversalPColumnId (unique column id)}
+	addedAxes := [] // Keep track of axes that are added to the table to prevent duplicates
+	filterMap := {} // Map column headers to filter criteria
 	if len(args.filters) > 0 {
 		for i, filter in args.filters {
 			if filter.value != undefined {
@@ -114,14 +113,14 @@ wf.body(func(args) {
 				// Store reference value and filter type associated to this column
 				filterMap["Filter_" + string(i)] = filter.filter
 			
-				// If column does not have main anchor axis we have to include theirs
+				// If column does not have main anchor axis we have to include theirs (columns coming from clustering blocks for example)
 				colsSpec := columns.getSpec(filter.value.column)
-				axesNames := slices.map(colsSpec.axesSpec, func (a) { return a.name})
+				axesNames := slices.map(colsSpec.axesSpec, func (a) {return a.name})
 				if !slices.hasElement(axesNames, datasetSpec.axesSpec[1].name) {
 					for na, ax in colsSpec.axesSpec {
 						if ax.name != datasetSpec.axesSpec[1].name {
 							cloneTable.setAxisHeader(ax.name, "cluster_" + string(i) + string(na))
-							addedAxes = slices.append(addedAxes, ax.name)
+							addedAxes = append(addedAxes, ax.name)
 						}
 					}
 				}	
@@ -134,12 +133,12 @@ wf.body(func(args) {
 		for i, col in args.rankingOrder {
 			cloneTable.add(columns.getColumn(col.value.column), {header: "Col" + string(i)})
 		
-			// If column does not have main anchor axis we have to include theirs
+			// If column does not have main anchor axis we have to include theirs (columns coming from clustering blocks for example)
 			colsSpec := columns.getSpec(col.value.column)
-			axesNames := slices.map(colsSpec.axesSpec, func (a) { return a.name})
+			axesNames := slices.map(colsSpec.axesSpec, func (a) {return a.name})
 			if !slices.hasElement(axesNames, datasetSpec.axesSpec[1].name) {
 				for na, ax in colsSpec.axesSpec {
-					if ax.name != datasetSpec.axesSpec[1].name && !slices.hasElement(addedAxes, ax.name) {
+					if ax.name != datasetSpec.axesSpec[1].name && !slices.hasElement(addedAxes, ax.name) { // Prevent duplicates
 						cloneTable.setAxisHeader(ax.name, "cluster_" + string(i) + string(na))
 					}
 				}
@@ -161,8 +160,8 @@ wf.body(func(args) {
 		}	
 	}
 
-	// Get linker columns if needed
-	linkerAxisSpec := {}
+	// Add linker columns when needed
+	linkerAxisSpec := {} // Map cluster axis names to specs. Is it needed????
 	if len(columns.getColumns("linkers")) > 0 {
 		for i, col in columns.getColumns("linkers") {
 			if datasetSpec.axesSpec[1].name == col.spec.axesSpec[1].name {
@@ -180,8 +179,8 @@ wf.body(func(args) {
 	cloneTable.cpu(1)
 	cloneTable = cloneTable.build()
 
-	// Use ender.create to call the filter-clonotypes template
-	filterResult := render.create(filterAndSampleTpl, {
+	// Use render.create to call the filtering and sampling clonotypes template
+	filterSampleResult := render.create(filterAndSampleTpl, {
 		inputAnchor: args.inputAnchor,
 		cloneTable: cloneTable,
 		rankingOrder: args.rankingOrder,
@@ -192,9 +191,9 @@ wf.body(func(args) {
 		topClonotypes: args.topClonotypes
 	})
 	
-	// Get the filtered clonotypes P-frame and CSV from the template result
-	finalClonotypesCsv := filterResult.output("finalClonotypesCsv", 24 * 60 * 60 * 1000)
-	// outputs["sampledRows"] = filterResult.output("sampledRows", 24 * 60 * 60 * 1000)
+	// Get the filtered and sampled clonotypes P-frame and CSV from the template result
+	finalClonotypesCsv := filterSampleResult.output("finalClonotypesCsv", 24 * 60 * 60 * 1000)
+	// outputs["sampledRows"] = filterSampleResult.output("sampledRows", 24 * 60 * 60 * 1000)
 	
 	////////// CDR3 Length Calculation //////////
 	
@@ -217,15 +216,15 @@ wf.body(func(args) {
 			chain := col.spec.domain["pl7.app/vdj/scClonotypeChain"]  // e.g., "A", "B"
 			receptor := col.spec.axesSpec[0].domain["pl7.app/vdj/receptor"]  // e.g., "IG", "TCRAB", "TCRGD"
 			chainLabel := chainMapping[receptor][chain]
-			return baseHeaderName + "." + chainLabel
+			return baseHeaderName + "." + chainLabel // e.g., "cdr3Sequence.Heavy"
 		} else {
 			// For bulk, if chain info is available (e.g. IGH, IGK, IGL)
 			chainFromDomain := col.spec.axesSpec[0].domain["pl7.app/vdj/chain"] // e.g. "IGH", "IGK"
 			if chainFromDomain != undefined {
-				return baseHeaderName + "." + chainFromDomain
+				return baseHeaderName + "." + chainFromDomain // e.g., "cdr3Sequence.IGH"
 			}
 		}
-		return baseHeaderName // Default header for bulk
+		return baseHeaderName
 	};
 
 	// Process CDR3 sequences
@@ -251,6 +250,7 @@ wf.body(func(args) {
 		headerName := makeHeaderName(col, "jGene", isSingleCell)
 		cdr3SeqTable.add(col, {header: headerName})
 	}
+
 	cdr3SeqTable.mem("16GiB")
 	cdr3SeqTable.cpu(1)
 	cdr3SeqTableBuilt := cdr3SeqTable.build()
@@ -280,7 +280,7 @@ wf.body(func(args) {
 		run()
 
 
-	// For spectratype structure is [chain][cdr3Length][vGene] -> count
+	// Spectratype PFrame structure is [chain][cdr3Length][vGene] -> count
 
 	cdr3VspectratypePf := xsv.importFile(cdr3VspectratypeCmd.getFile("spectratype.tsv"), 
 										"tsv", spectratypeConv.getColumns(),

package/src/prerun.tpl.tengo

@@ -182,7 +182,7 @@ wf.body(func(args) {
         cloneTable = cloneTable.build()
 
         // Use ender.create to call the filter-clonotypes template
-        filterResult := render.create(filterAndSampleTpl, {
+        filterSampleResult := render.create(filterAndSampleTpl, {
             inputAnchor: args.inputAnchor,
             cloneTable: cloneTable,
             topClonotypes: args.topClonotypes,
@@ -194,7 +194,7 @@ wf.body(func(args) {
         })
         
         // Get the filtered clonotypes from the template result
-        outputs["sampledRows"] = filterResult.output("sampledRows", 24 * 60 * 60 * 1000)
+        outputs["sampledRows"] = filterSampleResult.output("sampledRows", 24 * 60 * 60 * 1000)
     }
 
 	return {

package/src/sampled-cols-conv.lib.tengo

@@ -1,14 +1,7 @@
 ll := import("@platforma-sdk/workflow-tengo:ll")
 
-getColumns := func(datasetSpec) {
-  return {
-    axes: [
-      {
-        column: "clonotypeKey",
-        spec: datasetSpec.axesSpec[1]
-      }],
-    columns: [
-      {
+getColumns := func(datasetSpec, addRanking) {
+  columns := [{
         column: "top",
         id: "link",
         allowNA: false,
@@ -22,8 +15,31 @@ getColumns := func(datasetSpec) {
             "pl7.app/isSubset": "true"
           }
         }
-      }
-    ],
+      }]
+  if addRanking {
+    columns = columns + [{
+        column: "ranked_order",
+        spec: {
+          name: "pl7.app/vdj/ranking-order",
+          valueType: "Int",
+          domain: {},
+          annotations: {
+            "pl7.app/label": "Rank",
+            "pl7.app/table/visibility": "optional",
+            "pl7.app/isSubset": "true"
+          }
+        }
+      }]
+  }
+
+
+  return {
+    axes: [
+      {
+        column: "clonotypeKey",
+        spec: datasetSpec.axesSpec[1]
+      }],
+    columns: columns,
     storageFormat: "Binary",
     partitionKeyLength: 0
   }