Skip to content

Main content

Survey Self Description Opt Out Distinction Tool

Preserve self-description while distinguishing caller-defined opt-out and missing tokens.

Loading tool…

Description

Compare response exactly with each, returning opted-out, missing, or self-described; retain the response only for the last state and otherwise return an empty string.

Survey display order, self-description, missingness, and record support are distinct research properties. Literal tokens and counts can preserve those distinctions without inferring a person's identity, preferences, or the meaning of an unprovided response.

Compare response exactly with each, returning opted-out, missing, or self-described; retain the response only for the last state and otherwise return an empty string.

When to use this tool

Use Survey Self Description Opt Out Distinction when you need a transparent survey-record, display-order, or time-use calculation.

How to use the tool and how it works

  1. Enter response, optOutToken, missingToken. Use the units and conventions below.
  2. Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
  3. Read status, retainedResponse. Use the output convention below.

Require distinct optOutToken and missingToken. Compare response exactly with each, returning opted-out, missing, or self-described; retain the response only for the last state and otherwise return an empty string.1

Input fieldMeaning and unitsAccepted input
responseResponseRequired. Text; maximum UTF-16 length 8192.
optOutTokenOpt Out TokenRequired. Text; maximum UTF-16 length 8192.
missingTokenMissing TokenRequired. Text; maximum UTF-16 length 8192.
Output fieldInterpretationReturned shape
statusStatusRequired. Text; maximum UTF-16 length 8192.
retainedResponseRetained ResponseRequired. Text; maximum UTF-16 length 8192.
json
{
  "input": {
    "response": "prefer not to say",
    "optOutToken": "prefer not to say",
    "missingToken": ""
  },
  "output": {
    "status": "opted-out",
    "retainedResponse": ""
  }
}

Limitations and assumptions

  • No trimming, case folding, or identity inference occurs. The retained empty string is a placeholder for two statuses and can also be an actual self-description if tokens permit; read status alongside it.
  • Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.

Alternative or Complementary methods

Use the study's consent, vocabulary, missingness, and disclosure methodology for interpretation. Retain self-described information and assess sampling and privacy separately from local record arithmetic.

References

  1. Calculation and input contract: gender-studies/survey-self-description-opt-out-distinction — tool.io

Similar or alternative tools