Differences

This shows you the differences between two versions of the page.

--- matrixhilo [2022/10/13 14:14] – created admin
+++ matrixhilo [2023/06/21 10:50] (current) – [Embedded Field Names] admin
@@ Line 1: / Line 1: @@
-====== matrixHiLo - Get highest and lowest selected statements and scale points ======
+====== matrixHiLo - Get highest and lowest selected recode values, statements, and scale points from a matrix ======
-The **matrixHiLo** function sets embedded data fields for the highest and lowest selected recodes in a likert or bipolar matrix and the statements and scale points associated with those recodes. The embedded data fields can be used in for piping or display logic in follow-up questions.
+The **matrixHiLo** function sets embedded data fields for the highest and lowest selected recodes in a likert or bipolar matrix and the statements and scale points associated with those recodes. The embedded data fields can be used for piping or display logic in follow-up questions.
 The matrixHiLo function gets added to the matrix itself, so no additional logic is needed and the fields are available for use on the next page.
@@ Line 46: / Line 46: @@
 ==== Embedded Field Names ====
 === Recode Values ===
-High: {prefix}{delim}{hiText}{delim}{recodeText} (e.g., Q1.hi.recode)
+High: {prefix}{delim}{hiText}{delim}{recodeText} (e.g., Q1.hi.recode)\\
 Low: {prefix}{delim}{loText}{delim}{recodeText} (e.g., Q1.lo.recode)
 === Statements ===
-High: {prefix}{delim}{hiText}{delim}{stmtText} (e.g., Q1.hi.stmt)
+High: {prefix}{delim}{hiText}{delim}{stmtText} (e.g., Q1.hi.stmt)\\
 Low: {prefix}{delim}{loText}{delim}{stmtText} (e.g., Q1.lo.stmt)
-=== Statements ===
+=== Scale Point ===
-High: {prefix}{delim}{hiText}{delim}{scaleText} (e.g., Q1.hi.scale)
+High: {prefix}{delim}{hiText}{delim}{scaleText} (e.g., Q1.hi.scale)\\
 Low: {prefix}{delim}{loText}{delim}{scaleText} (e.g., Q1.lo.scale)
 ==== Saving Embedded Fields ====
 For maxtrixHiLo embedded data fields to be saved to Qualtrics response data the names must be defined as embedded fields in the survey flow. The embedded data fields must be defined before they are set in the matrix question. Only the fields that need to be saved need to be defined in the survey flow. For example, if you are only interested in high values, only add those embedded data fields to the survey flow. It is not necessary to save fields in order to pipe them.
 ===== Options =====
-==== allowTies ====
-**allowTies** is a boolean that specifies if ties are allowed. When **allowTies** is true, labels of choices with the same values will be combined and given the same rank. The options **[[csranks#and|and]]**, **[[csranks#join|join]]**, and **[[csranks#oxford|oxford]]** specify how labels are to be combined. When false, ties will be broken based on **[[csranks#otherSortArr|otherSortArr]]**.
-Default: false
-==== and ====
-**and** is text used to join the last label when **[[csranks#allowTies|allowTies]]** is true. If **and** is not empty, a space is added before and after if it does not start with a comma (,), colon (:), semi-colon (;), or pipe (|). For translated surveys pipe the value from a translated question.
-Default: "and"
-==== bpDelim ====
-**bpDelim** is a string delimiter used to separate the left and right statements in bipolar matrix.
-Default: " / "
 ==== bpDelim ====
 **bpDelim** is a string delimiter that applies only to bipolar matrix questions. The specified string is used to separate the left and right statements.
-Default: " / "
+Default: %%" / "%%
 ==== delim ====
 **delim** is a string delimiter used to break the embedded data field names into sections. The delimiter is placed between each section.
-Default: "."
+Default: %%"."%%
 ==== enteredTextOnly ====
-**enteredTextOnly** is a boolean that only applies to statements with "Allow text" turned on.  When **true** and the entered text field is not blank, only the entered text is included in the statement text (e.g., "this is the entered text").  When **false** the entered text, if not blank, is added to the statement text (e.g., "Statement 1: this is the entered text").
+**enteredTextOnly** is a boolean that only applies to statements with "Allow text" turned on.  When enteredTextOnly is **true** and the entered text field is not blank, only the entered text is included in the statement text (e.g., "this is the entered text").  When enteredTextOnly is **false** the entered text, if not blank, is added to the statement text (e.g., "Statement 1: this is the entered text").
 Default: false
@@ Line 84: / Line 72: @@
 **hiText** is a string used in embedded data field names of "high" recode value, statements, and scale point.
-Default: "hi"
+Default: %%"hi"%%
-==== joing ====
+==== join ====
 **join** is a string used to join multiple statements into a single string.
-Default: ", "
+Default: %%", "%%
 ==== loText ====
 **loText** is a string used in embedded data field names of "low" recode value, statements, and scale point.
-Default: "lo"
+Default: %%"lo"%%
 ==== naRecode ====
-**naRecode** is string that specifies a "not applicable" scale point. A "not applicable" scale point is ignored for highest/lowest consideration. A blank value ("") means there is no "not applicable" scale point.
+**naRecode** is string that specifies the recode value of a "not applicable" scale point. A "not applicable" scale point is ignored for highest/lowest consideration. A blank value ("") means there is no "not applicable" scale point.
-Default: ""
+Default: %%""%%
 ==== prefix ====
 **prefix** is a string used at the beginning of embedded data field names.
@@ Line 104: / Line 92: @@
 **recodeText** is the text used at the end of embedded data field names that contain recode values.
-Default: "recode"
+Default: %%"recode"%%
 ==== scaleText ====
 **scaleText** is the text used at the end of embedded data field names that contain scale points.
-Default: "scale"
+Default: %%"scale"%%
 ==== stmtText ====
 **stmtText** is the text used at the end of embedded data field names that contain statements.
-Default: "stmt"
+Default: %%"stmt"%%
 ==== textOnly ====
-**textOnly** is a boolean used to remove HTML from statements and scale points labels when set to true.
+**textOnly** is a boolean used to remove HTML from statements and scale point labels when set to true.
 Default: false
 ==== textVar ====
-**textVar** is a boolean used to save statement and scale point variable names instead of display (HTML) or text  values when **[[maxtrixhilo#textOnly|textOnly]]** AND **textVar** are true.
+**textVar** is a boolean used to save statement and scale point variable names instead of display (HTML) or text  values when **[[matrixhilo#textonly|textOnly]]** AND **textVar** are true.
 Default: false
 ====== Qualtrics Wiki ======
 [[start|Qualtrics Wiki]]