fix: conditionally enable regression methods based on term type and s…

client/mass/charts.js

@@ -43,6 +43,42 @@ class MassCharts {
 			!d.hide && this.state.currentCohortChartTypes.includes(d.chartType) ? '' : 'none'
 		)
 	}
+
+	generateRegressionButtonObject(state) {
+		// the default obj for regression, this obj is suitable for a button that will launch a menu with multiple regression methods
+		const obj = {
+			label: 'Regression Analysis',
+			chartType: 'regression',
+			clickTo: this.loadChartSpecificMenu
+		}
+		/* following detects if the ds has just one method, if so will customize obj{} so that the button directly show the available method name, and click on it to directly launch the ui without showing a menu, and will not trigger makeChartBtnMenu()
+		TODO move this logic to regression makeChartBtnMenu() to keep chart-specific logic out of here, but there lacks a way for makeChartBtnMenu to customize obj.label
+		*/
+		const lst = getCurrentCohortChartTypes(state)
+		if (!lst.includes('regression')) return obj // regression is hidden. still return obj to maintain proper charts array and the button will be hidden later
+		const availableMethods = []
+		if (lst.includes('linear')) availableMethods.push('linear')
+		if (lst.includes('logistic')) availableMethods.push('logistic')
+		if (lst.includes('cox')) availableMethods.push('cox')
+		if (availableMethods.length > 1) return obj // more than 1 regression methods. do not modify original obj
+		if (availableMethods.length == 1) {
+			// has only one method. customized button label and click behavior
+			obj.label =
+				(availableMethods[0] == 'linear' ? 'Linear' : availableMethods[0] == 'cox' ? 'Cox' : 'Logistic') + ' Regression'
+			obj.clickTo = () => {
+				this.dom.tip.hide()
+				this.prepPlot({
+					config: {
+						chartType: 'regression',
+						regressionType: availableMethods[0],
+						independent: []
+					}
+				})
+			}
+		}
+		// no method (exception?) this is handled by regression makeChartBtnMenu
+		return obj
+	}
 }
 
 export const chartsInit = getCompInit(MassCharts)
@@ -72,6 +108,8 @@ function getChartTypeList(self, state) {
 	each char type will generate a button under the nav bar
 	a dataset can support a subset of these charts
 
+	allow some chart button objects to be dynamically generated based on state
+
 	design goal is that chart specific logic should not leak into mass UI
 
 	design idea is that a button click will trigger a callback to do one of following things
@@ -114,8 +152,12 @@ function getChartTypeList(self, state) {
 
 	.updateActionBySelectedTerms:
 		optional callback. used for geneExpression and metabolicIntensity "intermediary" chart types which do not correspond to actual chart, but will route to an actual chart (summary/scatter/hierclust) based on number of selected terms. this callback will update the action based on selected terms to do the routing
+
+	TODO fixed order of buttons. may allow to customize order
 	*/
-	const [logged, site, user] = getProfileLogin() //later on replace with jwt login
+
+	const [logged, site, user] = getProfileLogin() // XXX later on replace with jwt login
+
 	const buttons = [
 		////////////////////// PROFILE PLOTS START //////////////////////
 		{
@@ -178,25 +220,20 @@ function getChartTypeList(self, state) {
 			clickTo: self.loadChartSpecificMenu
 		},
 		{
-			// should only show for official dataset, but not custom
 			label: 'Cumulative Incidence',
 			chartType: 'cuminc',
 			clickTo: self.showTree_select1term,
 			usecase: { target: 'cuminc', detail: 'term' }
 		},
 		{
-			// should only show for official dataset, but not custom
 			label: 'Survival',
 			chartType: 'survival',
 			clickTo: self.showTree_select1term,
 			usecase: { target: 'survival', detail: 'term' }
 		},
-		{
-			// should only show for official dataset, but not custom
-			label: 'Regression Analysis',
-			chartType: 'regression',
-			clickTo: self.loadChartSpecificMenu
-		},
+
+		self.generateRegressionButtonObject(state), // returns an object like other buttons but tailored by current state
+
 		{
 			label: 'Sample Matrix',
 			chartType: 'matrix',

client/plots/regression.js

@@ -210,18 +210,15 @@ export function makeChartBtnMenu(holder, chartsInstance) {
 	/*
 	holder: the holder in the tooltip
 	chartsInstance: MassCharts instance
-		termdbConfig is accessible at chartsInstance.state.termdbConfig{}
-		mass option is accessible at chartsInstance.app.opts{}
 	*/
-
-	const lst = [
+	const allMethods = [
 		{ label: 'Linear', type: 'linear' },
 		{ label: 'Logistic', type: 'logistic' },
 		{ label: 'Cox', type: 'cox' }
 	]
-
-	for (const { label, type } of lst) {
-		if (!chartsInstance.state.currentCohortChartTypes.includes(type)) continue
+	const useMethods = allMethods.filter(i => chartsInstance.state.currentCohortChartTypes.includes(i.type))
+	if (useMethods.length == 0) return holder.append('div').text('Error: no methods available')
+	for (const { label, type } of useMethods) {
 		holder
 			.append('div')
 			.attr('class', 'sja_menuoption sja_sharp_border')

release.txt

@@ -1 +1,2 @@
-
+Fixes:
+- conditionally enable regression methods based on term type and show customized Regression chart button if a single method is available

server/src/termdb.server.init.ts

@@ -581,14 +581,29 @@ const defaultCommonCharts: isSupportedChartCallbacks = {
 	dictionary: () => true,
 	summary: () => true,
 	matrix: () => true,
+
+	/*
+	parent type: regression
+	child types: linear/logistic/cox
+	- if parent is disabled, all child types are not accessible
+	- when parent is accessible, availability of each child type is individually calculated based on data types and allows for ds override for customization
+	*/
 	regression: () => true,
-	linear: () => true,
-	logistic: () => true,
-	cox: () => true,
+	linear: ({ cohortTermTypes }) => cohortTermTypes.numeric > 0, // numeric term present and could be used as linear outcome
+	logistic: () => true, // always enabled by default because: numeric/categorical/condition terms could all be used as outcome. later we will support custom samplelst term of two groups as outcome. a ds can provide an override to hide it if needed
+	cox: ({ cohortTermTypes }) => {
+		// requires either survival or condition term as cox outcome
+		return (cohortTermTypes.survival || 0) + (cohortTermTypes.condition || 0) > 0
+	},
+
 	facet: () => true,
 	survival: ({ cohortTermTypes }) => cohortTermTypes.survival > 0,
 	cuminc: ({ cohortTermTypes }) => cohortTermTypes.condition > 0,
 
+	/*
+	parent type: sampleScatter
+	child type: dynamicScatter
+	*/
 	sampleScatter: ({ ds, cohortTermTypes }) => {
 		// corresponds to the "Scatter Plot" chart button. it covers both premade scatter plots, as well as dynamic scatter input ui on clicking the "Scatter Plot" chart button
 		if (ds.cohort.scatterplots) return true
@@ -605,6 +620,7 @@ const defaultCommonCharts: isSupportedChartCallbacks = {
 		if (cohortTermTypes.numeric > 1) return true // numeric is always prefilled for convenience, does not have to check if property exists
 		return false
 	},
+
 	genomeBrowser: ({ ds }) => {
 		// will need to add more logic
 		if (ds.queries?.snvindel || ds.queries?.trackLst) return true