add documentation

inst/qml/NonParametricSurvivalAnalysis.qml

@@ -24,7 +24,9 @@ import JASP				1.0
 import "./qml_components"		as SA
 
 Form
-{
+{	
+	info: qsTr("This analysis computes a survival curve for censored data using the Kaplan-Meier estimator for single-event survival data. It estimates the probability of survival over time, allowing you to understand and visualize the distribution of survival times within your data. The analysis accommodates censored observations (subjects for whom the event has not occurred during the study period) and enables comparison of survival curves across different groups using statistical tests such as the Log-Rank test, Peto and Peto test, and Fleming-Harrington test. Additionally, you can generate life tables to summarize survival data at specified intervals.")
+
 	VariablesForm
 	{
 		AvailableVariablesList
@@ -38,6 +40,7 @@ Form
 			title:				qsTr("Time to Event")
 			allowedColumns:		["scale"]
 			singleVariable:		true
+			info: qsTr("Select the variable that represents the time until the event or censoring occurs.")
 		}
 
 		AssignedVariablesList
@@ -47,6 +50,7 @@ Form
 			title:				qsTr("Event Status")
 			allowedColumns:		["nominal"]
 			singleVariable:		true
+			info: qsTr("Choose the variable that indicates the event status, specifying whether each observation is an event or censored.")
 		}
 
 		DropDown
@@ -55,6 +59,7 @@ Form
 			label:				qsTr("Event Indicator")
 			source:				[{name: "eventStatus", use: "levels"}]
 			onCountChanged:		currentIndex = 1
+			info: qsTr("Specify the value in the Event Status variable that indicates the occurrence of the event.")
 		}
 
 		AssignedVariablesList
@@ -63,6 +68,7 @@ Form
 			id:					strata
 			title:			 	qsTr("Strata")
 			allowedColumns:		["nominal"]
+			info: qsTr("Select variables to define strata, allowing separate survival curves for each stratum.")
 		}
 	}
 
@@ -77,18 +83,21 @@ Form
 			{
 				name:		"testsLogRank"
 				label:		qsTr("Log-rank (Mantel-Haenszel)")
+				info: qsTr("Include the Log-Rank (Mantel-Haenszel) test to compare survival curves across strata.")
 			}
 
 			CheckBox
 			{
 				name:		"testsPetoAndPeto"
 				label:		qsTr("Peto and Peto")
+				info: qsTr("Include the Peto and Peto modification of the Gehan-Wilcoxon test to compare survival curves across strata.")
 			}
 
 			CheckBox
 			{
 				name:		"testsFlemmingHarrington"
 				label:		qsTr("Flemming-Harrington")
+				info: qsTr("Include the Fleming-Harrington test to compare survival curves across strata., with a customizable rho parameter.")
 
 				DoubleField
 				{
@@ -97,6 +106,7 @@ Form
 					defaultValue:	0.5
 					min:			0
 					max:			1
+					info: qsTr("Set the rho parameter for the Fleming-Harrington test, controlling the weight given to different time points (values between 0 and 1).")
 				}
 			}
 		}
@@ -105,12 +115,14 @@ Form
 		{
 			name:	"lifeTable"
 			label:	qsTr("Life table")
+			info: qsTr("Generate a life table summarizing survival data at specified time intervals.")
 
 			DropDown
 			{
 				name:		"lifeTableStepsType"
 				id:			lifeTableStepsType
 				label:		qsTr("Steps type")
+				info: qsTr("Select the method to define intervals for the life table: Default, Quantiles, or Fixed size.")
 				values:
 				[
 					{ label: qsTr("Default"),		value: "default"},
@@ -125,6 +137,7 @@ Form
 				label:			qsTr("Number")
 				defaultValue:	10
 				visible:		lifeTableStepsType.value == "quantiles"
+				info: qsTr("Specify the number of intervals when using Quantiles as the steps type.")
 			}
 
 			CheckBox
@@ -133,6 +146,7 @@ Form
 				label:		qsTr("Round steps")
 				checked:	true
 				visible:	lifeTableStepsType.value == "quantiles"
+				info: qsTr("Round the interval boundaries to the nearest integer when using Quantiles steps.")
 			}
 
 			DoubleField
@@ -143,6 +157,7 @@ Form
 				defaultValue:	0
 				max:			lifeTableStepsTo.value
 				visible:		lifeTableStepsType.value == "fixedSize"
+				info: qsTr("Set the starting time for intervals when using Fixed size steps.")
 			}
 
 			DoubleField
@@ -152,6 +167,7 @@ Form
 				defaultValue:	1
 				// max:			lifeTableStepsTo.value // TODO: enable once max is data dependent
 				visible:		lifeTableStepsType.value == "fixedSize"
+				info: qsTr("Define the size of each interval when using Fixed size steps.")
 			}
 
 			DoubleField
@@ -162,6 +178,7 @@ Form
 				defaultValue:	0
 				min:			lifeTableStepsFrom.value
 				visible:		lifeTableStepsType.value == "fixedSize"
+				info: qsTr("Set the ending time for intervals when using Fixed size steps.")
 			}
 		}
 	}