add documentation (2/2)

jasp-stats · Nov 6, 2024 · 9aa4550 · 9aa4550
1 parent f873fdb
commit 9aa4550
Show file tree

Hide file tree

Showing 7 changed files with 85 additions and 16 deletions.
diff --git a/inst/help/FunnelPlot.md b/inst/help/FunnelPlot.md
diff --git a/inst/qml/ClassicalMetaAnalysisMultilevelMultivariate.qml b/inst/qml/ClassicalMetaAnalysisMultilevelMultivariate.qml
@@ -110,7 +110,7 @@ Form
 	{	
 		title:		qsTr("Random Effects / Model Structure")
 		expanded:	true
-		info: qsTr("Specify the random effects structure for the meta-analysis model, including the types of random effects and their associated variables. Allows modeling of complex data structures such as multilevel, multivariate, autoregressive, spatial, and other forms of dependency.")
+		info: qsTr("Options for specifying the random effects structure for the meta-analysis model, including the types of random effects and their associated variables. Allows modeling of complex data structures such as multilevel, multivariate, autoregressive, spatial, and other forms of dependency.")
 
 		ComponentsList
 		{

diff --git a/inst/qml/FunnelPlot.qml b/inst/qml/FunnelPlot.qml
@@ -24,6 +24,8 @@ import JASP				1.0
 Form
 {
 
+	infoBottom: qsTr("Kossmeier, M., Tran, U. S., & Voracek, M. (2020). Power-enhanced funnel plots for meta-analysis. Zeitschrift für Psychologie, 228(1).")
+
 	VariablesForm
 	{
 		preferredHeight: 200 * preferencesModel.uiScale
@@ -39,6 +41,7 @@ Form
 			name:				"effectSize"
 			singleVariable:		true
 			allowedColumns:		["scale"]
+			info: qsTr("Variable containing the observed effect sizes.")
 		}
 
 		AssignedVariablesList
@@ -47,6 +50,7 @@ Form
 			title:				qsTr("Effect Size Standard Error")
 			singleVariable:		true
 			allowedColumns:		["scale"]
+			info: qsTr("Variable containing the standard errors corresponding to the effect sizes.")
 		}
 
 		AssignedVariablesList
@@ -56,6 +60,7 @@ Form
 			title:				qsTr("Study Label")
 			singleVariable:		true
 			allowedColumns:		["nominal"]
+			info: qsTr("Variable containing labels for the studies. Used for labeling outputs and plots.")
 		}
 
 		AssignedVariablesList
@@ -64,6 +69,7 @@ Form
 			title:				qsTr("Split")
 			singleVariable:		true
 			allowedColumns:		["nominal"]
+			info: qsTr("Variable used to split the funnel plot into separate groups or categories.")
 		}
 	}
 
@@ -73,6 +79,7 @@ Form
 		id:			funnelUnderH0
 		label:		qsTr("Funnel under H₀")
 		checked:	true
+		info: qsTr("Specify the funnel plot under the null hypothesis.")
 
 		Group
 		{
@@ -84,6 +91,7 @@ Form
 				name: 				"funnelUnderH0ParametersFixedMu"
 				defaultValue:		0
 				negativeValues:		true
+				info: qsTr("Fixed value for the mean effect size under the null hypothesis.")
 			}
 
 			DoubleField
@@ -92,6 +100,7 @@ Form
 				name: 				"funnelUnderH0ParametersFixedTau"
 				defaultValue:		0
 				min: 				0
+				info: qsTr("Fixed value for 𝜏, representing the heterogeneity under the null hypothesis.")
 			}
 		}
 
@@ -100,12 +109,14 @@ Form
 			name:		"funnelUnderH0FillColors"
 			label:		qsTr("Fill colors")
 			checked:	true
+			info: qsTr("Fill the funnel plot's prediction intervals under the null hypothesis with different colors.")
 		}
 
 		DropDown
 		{
 			name:		"funnelUnderH0LineType"
 			label:		qsTr("Line type")
+			info: qsTr("Set the type of line of the funnel plot's prediction intervals under the null hypothesis.")
 			values:		[
 				{ label: qsTr("None"),		value: "none"	},
 				{ label: qsTr("Solid"),		value: "solid"	},
@@ -121,13 +132,15 @@ Form
 		id:			funnelUnderH1
 		label:		qsTr("Funnel under H₁")
 		checked:	false
+		info: qsTr("Estimate or specify the funnel plot under the alternative hypothesis.")
 
 		RadioButtonGroup
 		{
 			name:		"funnelUnderH1Parameters"
 			title:		qsTr("Parameters")
 			columns:	2
 			radioButtonsOnSameRow: true
+			info: qsTr("Choose whether to estimate or manually fix the parameters for the funnel plot under the alternative hypothesis.")
 
 			RadioButton
 			{
@@ -155,6 +168,7 @@ Form
 				id:				method
 				label:			qsTr("Method")
 				startValue:		"restrictedML"
+				info: qsTr("Select the heterogeneity estimation method for the funnel plot under the alternative hypothesis.")
 				values:			[
 					{ label: qsTr("Equal Effects")			, value: "equalEffects"		},
 					{ label: qsTr("Fixed Effects")			, value: "fixedEffects"		},
@@ -175,13 +189,15 @@ Form
 			{
 				name:		"funnelUnderH1IncludeHeterogeneity"
 				label:		qsTr("Include heterogeneity")
-				enabled:	method.value != "fixedEffects" && method.value != "equalEffects" 
+				enabled:	method.value != "fixedEffects" && method.value != "equalEffects"
+				info: qsTr("Include heterogeneity (𝜏) in the funnel plot under the alternative hypothesis. If unselected, the heterogeneity estimate is not used to adjust the prediction intervals.") 
 			}
 
 			CheckBox
 			{
 				name:		"funnelUnderH1EstimatesTable"
 				label:		qsTr("Estimates table")
+				info: qsTr("Summarize the effect size and heterogeneity estimates used for the funnel plot under the alternative hypothesis in a table.")
 			}
 		}		
 
@@ -195,6 +211,7 @@ Form
 				name: 				"funnelUnderH1ParametersFixedMu"
 				defaultValue:		0
 				negativeValues:		true
+				info: qsTr("Fixed value for the mean effect size under the alternative hypothesis.")
 			}
 
 			DoubleField
@@ -203,20 +220,23 @@ Form
 				name: 				"funnelUnderH1ParametersFixedTau"
 				defaultValue:		0
 				min: 				0
+				info: qsTr("Fixed value for 𝜏, representing the heterogeneity under the alternative hypothesis.")
 			}
 		}
 
 		CheckBox
 		{
 			name:		"funnelUnderH1FillColors"
 			label:		qsTr("Fill colors")
+			info: qsTr("Fill the funnel plot's prediction intervals under the alternative hypothesis with different colors.")
 		}
 
 		DropDown
 		{
 			name:		"funnelUnderH1LineType"
 			label:		qsTr("Line type")
 			startValue:	"solid"
+			info: qsTr("Set the type of line of the funnel plot's prediction intervals under the alternative hypothesis.")
 			values:		[
 				{ label: qsTr("None"),		value: "none"	},
 				{ label: qsTr("Solid"),		value: "solid"	},
@@ -230,13 +250,15 @@ Form
 			name:		"funnelUnderH1PowerEnhancement"
 			enabled:	funnelUnderH1.checked
 			label:		qsTr("Power enhancement")
+			info: qsTr("Visualize power levels to detect the effect size under the alternative hypothesis with alpha = 0.05.")
 
 			TextField
 			{
 				label: 				qsTr("Breaks")
 				name: 				"funnelUnderH1PowerEnhancementBreaks"
 				value:				"(0.15, 0.30, 0.50, 0.70, 0.90)"
 				fieldWidth: 		200 * preferencesModel.uiScale
+				info: qsTr("Specify the breakpoints for power enhancement. All levels must be within the 0.05 - 1 range.")
 			}
 		}
 	}
@@ -245,11 +267,13 @@ Form
 	Group
 	{
 		title:	qsTr("Estimates Mapping")
+		info: qsTr("Set mapping for labels, colors, and shapes of the effect size estimates.")
 
 		DropDown
 		{
 			label:		qsTr("Label")
 			name:		"estimatesMappingLabel"
+			info: qsTr("Show all or only a subset of the effect size estimate labels.")
 			enabled: 	studyLabel.count > 0
 			values:		{
 				if (funnelUnderH0.checked && funnelUnderH1.checked) {
@@ -287,6 +311,7 @@ Form
 			label:			qsTr("Color")
 			addEmptyValue:	true
 			allowedColumns:	["nominal"]
+			info: qsTr("Map colors of the effect size estimates in the funnel plot based on the selected variable.")
 		}
 
 		DropDown
@@ -296,6 +321,8 @@ Form
 			label:			qsTr("Shape")
 			addEmptyValue:	true
 			allowedColumns:	["nominal"]
+			info: qsTr("Map shapes of the effect size estimates in the funnel plot based on the selected variable.")
+
 		}
 
 		DropDown
@@ -304,6 +331,7 @@ Form
 			enabled:		estimatesMappingColor.checked || estimatesMappingShape.checked
 			label:			qsTr("Legend position")
 			startValue:		"right"
+			info: qsTr("Set the legend position of the funnel plot. Available when color or shape mapping is enabled.")
 			values:
 			[
 				{ label: qsTr("None"),			value: "none"},
@@ -319,6 +347,7 @@ Form
 			name:			"estimatesMappingLabelOffset"
 			label:			qsTr("Label offset")
 			defaultValue:	0.10
+			info: qsTr("Adjust the offset of labels in the funnel plot.")
 		}
 	}
 
@@ -331,37 +360,45 @@ Form
 			name: 				"funnelPredictionInterval"
 			value:				"(0.90, 0.95, 0.99)"
 			fieldWidth: 		120 * preferencesModel.uiScale
+			info: qsTr("Specify the confidence levels for the funnel plot prediction intervals.")
 		}
 
 		CheckBox
 		{
 			name:		"invertColors"
 			label:		qsTr("Invert colors")
+			info: qsTr("Invert the colors used in the funnel plot.")
 		}
 	}
 
 	CheckBox
 	{
 		name:		"funnelPlotAsymmetryTests"
 		label:		qsTr("Funnel plot asymmetry tests")
+		info: qsTr("Perform tests to detect asymmetry in the funnel plot indicating potential publication bias. The tests are performed with the 'Method' specified in the 'Funnel under H₁' option.")
+
 
 		CheckBox
 		{
 			name:		"funnelPlotAsymmetryTestsMetaRegression"
 			label:		qsTr("Meta-regression")
 			checked:	true
+			info: qsTr("Include meta-regression tests for funnel plot asymmetry.")
 		}
 
 		CheckBox
 		{
 			name:		"funnelPlotAsymmetryTestsWeightedRegression"
 			label:		qsTr("Weighted regression")
+			info: qsTr("Include weighted regression tests for funnel plot asymmetry.")
+
 		}
 
 		CheckBox
 		{
 			name:		"funnelPlotAsymmetryTestsRankCorrelation"
 			label:		qsTr("Rank correlation")
+			info: qsTr("Include rank correlation tests for funnel plot asymmetry.")
 		}
 	}
 }
diff --git a/inst/qml/qml_components/ClassicalMetaAnalysisBubblePlot.qml b/inst/qml/qml_components/ClassicalMetaAnalysisBubblePlot.qml
@@ -45,7 +45,7 @@ Section
 			title:			qsTr("Selected Variable")
 			singleVariable:	true
 			allowTypeChange:false
-			info: qsTr("Variable to be visualized at the x-axis.")
+			info: qsTr("Variable to be visualized on the x-axis.")
 		}
 
 		AssignedVariablesList
@@ -86,7 +86,7 @@ Section
 
 			Group
 			{
-				title:		qsTr("Bubles")
+				title:		qsTr("Bubbles")
 
 				DropDown
 				{
@@ -140,7 +140,7 @@ Section
 				name:		"bubblePlotConfidenceIntervals"
 				label:		qsTr("Condifence intervals")
 				checked:	true
-				info: qsTr("Include confidence interval of the estimated effect sizes.")
+				info: qsTr("Include confidence intervals of the estimated effect sizes.")
 
 				DoubleField
 				{
@@ -158,7 +158,7 @@ Section
 				name:		"bubblePlotPredictionIntervals"
 				label:		qsTr("Prediction intervals")
 				checked:	true
-				info: qsTr("Include prediction interval of the estimated effect sizes.")
+				info: qsTr("Include prediction intervals of the estimated effect sizes.")
 
 				DoubleField
 				{
@@ -183,7 +183,7 @@ Section
 				id:				bubblePlotTheme	
 				label:			qsTr("Theme")
 				startValue:		"jasp"
-				info: qsTr("Set theme of the bubble plot.")
+				info: qsTr("Set the theme of the bubble plot.")
 				values:
 				[
 					{ label: "JASP",					value: "jasp"},
@@ -210,7 +210,7 @@ Section
 			{
 				name:			"bubblePlotLegendPosition"
 				label:			qsTr("Legend position")
-				info: qsTr("Set legend of the bubble plot.")
+				info: qsTr("Set the legend position of the bubble plot.")
 				startValue:		"right"
 				values:
 				[