@baravak/risloo-profile-cli 3.1.0

package/src/samples/SCASP93.js

@@ -0,0 +1,207 @@
+const { Profile, Dataset } = require("../Profile");
+
+class SCASP93 extends Profile {
+  // Number of pages
+  static pages = 1;
+
+  // Labels of the sample
+  labels = {
+    L1: { eng: "total", fr: "نمره کل" },
+    L2: { eng: "panic_attack_and_agorophobia", fr: "اختلال هراس و ترس از فضای باز" },
+    L3: { eng: "separation_anxiety", fr: "اضطراب جدایی" },
+    L4: { eng: "physical_injury_fears", fr: "ترس از آسیب فیزیکی" },
+    L5: { eng: "social_phobia", fr: "ترس اجتماعی" },
+    L6: { eng: "obsessive_compulsive", fr: "وسواس فکری - عملی" },
+    L7: { eng: "generalized_anxiety_disorder", fr: "اضطراب عمومی (فراگیر)" },
+  };
+
+  profileSpec = {
+    /* "sample" determines some important info about the sample and profile */
+    /* Default prerequisites: 1. gender, 2. age, 3. education */
+    /* "prerequisites" is synonym to "fields" in our program */
+    sample: {
+      name: "پرسشنامه اضطراب کودکان اسپنس - نسخه والدین" /* Name of the sample */,
+      multiProfile: false /* Whether the sample has multiple profiles or not */,
+      questions: true /* Determines whether to get questions from inital dataset or not */,
+      defaultFields: false /* Determines whether to have default prerequisites in the profile or not */,
+      fields: [
+        "child_name",
+        { merge: ["child_age", "child_gender"], fr: "سن کودک / جنسیت", valueFormat: "{0} / {1}" },
+        { eng: "birth_order", fr: "فرزند چندم" },
+        { merge: ["sons", "daughters"], fr: "تعداد فرزندان (دختر / پسر)", valueFormat: "{1} دختر / {0} پسر" },
+        "father_education",
+        "father_job",
+        "mother_education",
+        "mother_job",
+      ] /* In case you want to get some additional fields and show in the profile */,
+    },
+    /* "profile" determines the dimensions of the drawn profile (to be used in svg tag viewbox) */
+    /* calculating its dimensions carefully is of great importance */
+    profile: {
+      get dimensions() {
+        return {
+          width: 840 + 2 * this.padding.x,
+          height: 679 + 2 * this.padding.y,
+        };
+      },
+      padding: {
+        x: 0,
+        y: 13,
+      },
+    },
+    /* "raw" is the general term used for total data element in the profile */
+    raw: {
+      maxValue: 114 /* Maximum value of raw */,
+      offsetY: 80 /* Vertical offset between last item and raw */,
+      leftPos: 73 /* Left position of the raw rectangle */,
+      rect: {
+        width: 740 /* Width of the raw rectangle */,
+        height: 40 /* Height of the raw rectangle */,
+        br: 5 /* Border radius of the raw rectangle */,
+      },
+      label: {
+        offsetX: 23 /* Horizontal offset between label and raw rectangle */,
+      },
+      mark: {
+        maxValueOffsetX: 10 /* Horizontal offset between maximum value and raw rectangle */,
+        line: {
+          offsetY: 5 /* Vertical offset between mark line and raw rectangle */,
+          length: 10 /* Length of mark line */,
+        },
+        number: {
+          offsetY: 13 /* Vertical offset between mark line and mark number */,
+        },
+      },
+    },
+    /* "descAnswer" determines the geometrical properties for the descriptive answer part */
+    descAnswer: {
+      offsetY: 40 /* Vertical offset between raw and descriptive answer rectangle */,
+      rect: {
+        width: 840 /* Width of the descriptive answer rectangle */,
+        height: 100 /* Height of the descriptive answer rectangle */,
+        br: 8 /* Border radius of the descriptive answer rectangle */,
+        padding: 20 /* Padding of the descriptive answer rectangle */,
+      },
+      content: {
+        lineHeight: 25 /* Line height of the descriptive answer */,
+      },
+    },
+    /* "items" is the general term used for independent data elements to be drawn in the profile */
+    items: {
+      header: {
+        offsetY1: 17,
+        offsetY2: 42,
+        get height() {
+          return this.offsetY1 + this.offsetY2;
+        } /* Height of header row */,
+        legend: {
+          leftPos: 756 /* Left position of legend part of header */,
+          rect: {
+            width: 12 /* Width of legend rectangle */,
+            height: 12 /* Height of legend rectangle */,
+            br: 2 /* Border radius of legend rectangle */,
+            offsetX: 10 /* Horizontal offset between legend rectangles */,
+            get distanceX() {
+              return this.width + this.offsetX;
+            } /* Horizontal distance between legend rectangles */,
+          },
+        },
+      } /* Header part of the items table */,
+      separatorLine: {
+        length: 840 /* Length of separator line between each row of the items table */,
+      },
+      maxValues: {
+        [this.labels.L2.eng]: 27,
+        [this.labels.L3.eng]: 18,
+        [this.labels.L4.eng]: 15,
+        [this.labels.L5.eng]: 18,
+        [this.labels.L6.eng]: 18,
+        [this.labels.L7.eng]: 18,
+      } /* Maximum value of items */,
+      questionNumbers: {
+        [this.labels.L2.eng]: [12, 19, 25, 27, 28, 30, 32, 33, 34],
+        [this.labels.L3.eng]: [5, 8, 11, 14, 15, 38],
+        [this.labels.L4.eng]: [2, 16, 21, 23, 29],
+        [this.labels.L5.eng]: [6, 7, 9, 10, 26, 31],
+        [this.labels.L6.eng]: [13, 17, 24, 35, 36, 37],
+        [this.labels.L7.eng]: [1, 3, 4, 18, 20, 22],
+      } /* Questions numbers array of each item */,
+      offsetY: 60 /* Vertical offset between two items */,
+      leftPosArr: [50, 282, 312] /* Left position array of items table cells */,
+      paddingY: 10 /* Vertical padding inside items table cell */,
+      rect: {
+        width: 50 /* Width of the items rectangle */,
+        height: 40 /* Height of the items rectangle */,
+        br: 4 /* Border radius of the items rectangle */,
+        offsetX: 9 /* Horizontal offset between two items rectangles */,
+        get distanceX() {
+          return this.width + this.offsetX;
+        } /* Horizontal distance between two items rectangles */,
+        intensities: {
+          0: {
+            fill: "white",
+            stroke: "#D6D3D1",
+            textFill: "#A8A29E",
+          },
+          1: {
+            fill: "#FCA5A5",
+            stroke: "none",
+            textFill: "white",
+          },
+          2: {
+            fill: "#EF4444",
+            stroke: "none",
+            textFill: "white",
+          },
+          3: {
+            fill: "#B91C1C",
+            stroke: "none",
+            textFill: "white",
+          } /* Fill and stroke of different intensities of items rectangles */,
+        },
+      },
+    },
+    /* "labels" part which has to be provided for each profile */
+    labels: Object.values(this.labels),
+  };
+
+  constructor(dataset, options, config = {}) {
+    super();
+    this._init(dataset, options, config);
+  }
+
+  _calcContext() {
+    const {
+      spec: { parameters: spec },
+      dataset,
+    } = this;
+
+    // Deconstructing the Spec of the Profile
+    const { raw: rawSpec, items: itemsSpec } = spec;
+
+    // Separate Raw Data from the Dataset
+    const rawData = dataset.score.shift();
+
+    const raw = {
+      mark: rawData.mark,
+      label: rawData.label,
+      width: (rawData.mark / rawSpec.maxValue) * rawSpec.rect.width,
+    };
+
+    const items = dataset.score.map((data) => ({
+      mark: data.mark,
+      label: data.label,
+      maxValue: itemsSpec.maxValues[data.label.eng],
+      questions: itemsSpec.questionNumbers[data.label.eng].map((number) => ({
+        number,
+        intensity: itemsSpec.rect.intensities[dataset.questions[number - 1].user_answered - 1],
+      })),
+    }));
+
+    const descAnswer = dataset.questions[dataset.questions.length - 1].user_answered;
+
+    return [{ raw, items, descAnswer }];
+  }
+}
+
+module.exports = SCASP93;

package/src/samples/SDCAQ93.js

@@ -0,0 +1,174 @@
+const { Profile, FS } = require("../Profile");
+
+class SDCAQ93 extends Profile {
+  // Number of pages
+  static pages = 1;
+
+  // Labels of the sample
+  labels = {
+    L1: { eng: "thought_suppression", fr: "واپس زنی\nافکار نگران‌کننده" },
+    L2: { eng: "thought_substitution", fr: "جانشینی افکار مثبت\nبه جای افکار نگران‌کننده" },
+    L3: { eng: "distraction_subscale", fr: "استفاده از توجه برگردانی\nبرای قطع روند نگرانی (حواس‌پرتی)" },
+    L4: { eng: "avoidance_of_threatening_stimuli", fr: "اجتناب از موقعیت‌ها و فعالیت‌های\nفعال‌ساز افکار نگران‌کننده" },
+    L5: { eng: "transformation_of_images_into_thoughts", fr: "تغییر تصاویر ذهنی\nبه افکار کلامی" },
+    L6: { eng: "raw", fr: "نمره کل" },
+  };
+
+  profileSpec = {
+    /* "sample" determines some important info about the sample and profile */
+    /* Default prerequisites: 1. gender, 2. age, 3. education */
+    /* "prerequisites" is synonym to "fields" in our program */
+    sample: {
+      name: "پرسشنامه اجتناب شناختی سکستون وداگاس" /* Name of the sample */,
+      multiProfile: false /* Whether the sample has multiple profiles or not */,
+      questions: false /* Determines whether to get questions from inital dataset or not */,
+      defaultFields: true /* Determines whether to have default prerequisites in the profile or not */,
+      fields: ["marital_status"] /* In case you want to get some additional fields and show in the profile */,
+    },
+    /* "profile" determines the dimensions of the drawn profile (to be used in svg tag viewbox) */
+    /* calculating its dimensions carefully is of great importance */
+    profile: {
+      get dimensions() {
+        return {
+          width: 832 + 2 * this.padding.x,
+          height: 500 + 2 * this.padding.y,
+        }
+      },
+      padding: {
+        x: 35,
+        y: 15,
+      },
+    },
+    /* "raw" is the general term used for total data element in the profile */
+    raw: {
+      minValue: 25 /* Minimum values of raw marks provided by the dataset */,
+      maxValue: 125 /* Maximum values of raw marks provided by the dataset */,
+      offsetX: 110 /* Horizontal offset from items */,
+      ticks: {
+        num: 5 /* Number of ticks */,
+        line: {
+          width: 10 /* Width of the tick line */,
+          offsetX: 7 /* Horizontal offset from the rectangle */,
+        },
+        number: {
+          offsetX: 4 /* Horizontal Offset from the line */,
+        },
+      },
+      rect: {
+        width: 50 /* Width of the raw rectangle */,
+        get borderRadius() {
+          return this.width / 2;
+        } /* Border radius of the raw rectangle */,
+      },
+      heightCoeff: 4 /* Used for converting mark to the height */,
+    },
+    /* "items" is the general term used for independent data elements to be drawn in the profile */
+    items: {
+      minValue: 5 /* Minimum value of items mark provided by the dataset */,
+      maxValue: 25 /* Maximum value of items mark provided by the dataset */,
+      offsetX: 228 /* Horizontal offset between items and left side of profile */,
+      offsetY: 40 /* Vertical offset between two consecutive item in the profile */,
+      get distanceY() {
+        return this.offsetY + this.rect.height;
+      } /* Distance between two consecutive item in the profile */,
+      totalHeight: "" /* To be calculated in the class with the function provided */,
+      calcTotalHeight: function (n) {
+        return this.distanceY * (n - 1) + this.rect.height;
+      } /* Method for calculating the total height of items */,
+      ticks: {
+        num: 5 /* Number of ticks */,
+        heightOffset: 45 /* Half length that the ticks lines of items is greater than items total heigth */,
+        numberOffset: {
+          x: 10 /* Horizontal distance from the line */,
+          y: 10 /* Vertical distance from the line */,
+        },
+      },
+      rect: {
+        height: 50 /* Height of the items rectangle */,
+        get borderRadius() {
+          return this.height / 2;
+        } /* Border Radius of the items rectangle */,
+        colors: ["#A78BFA", "#10B981", "#EC4899", "#F59E0B", "#007BA4"] /* Colors used for theming items body parts */,
+      },
+      widthCoeff: 16 /* Used for converting mark to the width */,
+      label: {
+        offsetX: 10 /* Horizontal offset of label from item */,
+        offsetY: 13 /* Half vertical offset between two lines of label */,
+      },
+    },
+    /* "labels" part which has to be provided for each profile */
+    labels: Object.values(this.labels),
+  };
+
+  constructor(dataset, options, config = {}) {
+    super();
+    this._init(dataset, options, config);
+  }
+
+  _calcContext() {
+    const {
+      spec: { parameters: spec },
+      dataset,
+    } = this;
+
+    const { raw: rawSpec, items: itemsSpec } = spec;
+
+    // Separate Raw Data from the Dataset
+    const rawData = dataset.score.pop();
+
+    // ّInit Spec
+    spec.items.totalHeight = spec.items.calcTotalHeight(dataset.score.length);
+
+    // Gather Required Info for Raw
+    const raw = {
+      label: rawData.label,
+      mark: rawData.mark,
+      height: rawData.mark * rawSpec.heightCoeff,
+    };
+
+    // Gather Required Info for Items
+    const items = dataset.score.map((data, index) => ({
+      label: data.label,
+      mark: data.mark,
+      width: data.mark * itemsSpec.widthCoeff,
+      fill: itemsSpec.rect.colors[index],
+    }));
+
+    // Calculate Ticks Numbers Array for Raw
+    const rawTicksNumbers = FS.createArithmeticSequence(
+      rawSpec.minValue,
+      (rawSpec.maxValue - rawSpec.minValue) / (rawSpec.ticks.num - 1),
+      rawSpec.ticks.num
+    );
+
+    // Gather Required Info for Raw Ticks
+    const rawTicks = rawTicksNumbers.map((tick) => ({
+      number: tick,
+      bottomPos: tick * rawSpec.heightCoeff,
+    }));
+
+    // Calculate Ticks Numbers Array for Items
+    const itemsTicksNumbers = FS.createArithmeticSequence(
+      itemsSpec.minValue,
+      (itemsSpec.maxValue - itemsSpec.minValue) / (itemsSpec.ticks.num - 1),
+      itemsSpec.ticks.num
+    );
+
+    // Gather Required Info for Items Ticks
+    const itemsTicks = itemsTicksNumbers.map((tick) => ({
+      number: tick,
+      leftPos: tick * itemsSpec.widthCoeff,
+    }));
+
+    return [
+      {
+        raw,
+        items,
+        rawTicks,
+        itemsTicks,
+      },
+    ];
+  }
+}
+
+module.exports = SDCAQ93;

package/src/samples/STAIY93.js

@@ -0,0 +1,159 @@
+const { Profile, FS } = require("../Profile");
+
+class STAIY93 extends Profile {
+  // Number of pages
+  static pages = 1;
+
+  // Labels of the sample
+  labels = {
+    L1: { eng: "trait", fr: "رگه اضطراب" },
+    L2: { eng: "state", fr: "حالت اضطراب" },
+  };
+
+  profileSpec = {
+    /* "sample" determines some important info about the sample and profile */
+    /* Default prerequisites: 1. gender, 2. age, 3. education */
+    /* "prerequisites" is synonym to "fields" in our program */
+    sample: {
+      name: "پرسشنامه حالت - رگه اضطراب اسپیلبرگر" /* Name of the sample */,
+      multiProfile: false /* Whether the sample has multiple profiles or not */,
+      questions: false /* Determines whether to get questions from inital dataset or not */,
+      defaultFields: true /* Determines whether to have default prerequisites in the profile or not */,
+      fields: ["marital_status"] /* In case you want to get some additional fields and show in the profile */,
+    },
+    /* "profile" determines the dimensions of the drawn profile (to be used in svg tag viewbox) */
+    /* calculating its dimensions carefully is of great importance */
+    profile: {
+      get dimensions() {
+        return {
+          width: 550 + 2 * this.padding.x,
+          height: 476 + 2 * this.padding.y,
+        }
+      },
+      padding: {
+        x: 70,
+        y: 70,
+      },
+    },
+    /* "items" is the general term used for independent data elements to be drawn in the profile */
+    items: {
+      rect: {
+        width: 180 /* Width of label rectangle */,
+        height: 42 /* Height of label rectangle */,
+        br: 10 /* Border radius of label rectangle */,
+        offsetX: 190 /* Horizontal offset between label rectangles */,
+        offsetY: 84 /* Vetical offset between label rectangles and items */,
+        get distanceY() {
+          return this.height + this.offsetY;
+        },
+      },
+      offsetX: 2 /* Horizontal offset between two items element */,
+      minValue: 20 /* Minimum value of items data element */,
+      maxValue: 80 /* Maximum value of items data element */,
+      get range() {
+        return this.maxValue - this.minValue;
+      },
+      trait: {
+        stops: [20, 34, 45, 56, 80],
+        fill: "#581C87",
+        circle: {
+          R: 175 /* Radius of the outer circle of the items element */,
+          r: 130 /* Radius of the inner circle of the items element */,
+          brs: {
+            tl: 0 /* Top left border radius */,
+            bl: 0 /* Bottom left border radius */,
+            tr: 0 /* Top right border radius */,
+            br: 0 /* Bottom right border radius */,
+          } /* Border radiuses at each end of the gauge of the items element */,
+          angles: {
+            start: FS.toRadians(-90),
+            end: FS.toRadians(90),
+          } /* Angles of each end of the items element */,
+          direction: false /* Clockwise direction for the items gauge element */,
+        },
+      },
+      state: {
+        stops: [20, 30, 42, 53, 80],
+        fill: "#BE185D",
+        circle: {
+          R: 175 /* Radius of the outer circle of the items element */,
+          r: 130 /* Radius of the inner circle of the items element */,
+          brs: {
+            tl: 0 /* Top left border radius */,
+            bl: 0 /* Bottom left border radius */,
+            tr: 0 /* Top right border radius */,
+            br: 0 /* Bottom right border radius */,
+          } /* Border radiuses at each end of the gauge of the items element */,
+          angles: {
+            start: FS.toRadians(-90),
+            end: FS.toRadians(90),
+          } /* Angles of each end of the items element */,
+          direction: true /* Clockwise direction for the items gauge element */,
+        },
+      },
+      interprets: [
+        { opacity: 0.4, eng: "none", fr: "هیچ یا کمترین حد" },
+        { opacity: 0.6, eng: "mild", fr: "خفیف" },
+        { opacity: 0.8, eng: "moderate", fr: "متوسط" },
+        { opacity: 1, eng: "severe", fr: "شدید" },
+      ],
+    },
+    /* "labels" part which has to be provided for each profile */
+    labels: Object.values(this.labels),
+  };
+
+  constructor(dataset, options, config = {}) {
+    super();
+    this._init(dataset, options, config);
+  }
+
+  _calcContext() {
+    const {
+      spec: { parameters: spec },
+      dataset,
+    } = this;
+
+    // Deconstructing the Spec of the Profile
+    const { items: itemsSpec } = spec;
+
+    const items = dataset.score.map((data) => ({
+      label: data.label,
+      mark: data.mark,
+      angle: this._markToAngle(
+        data.mark.value,
+        itemsSpec.minValue,
+        itemsSpec.maxValue,
+        itemsSpec[data.label.eng].circle.angles,
+        itemsSpec[data.label.eng].circle.direction
+      ),
+      stops: itemsSpec[data.label.eng].stops.map((stop) => ({
+        mark: stop,
+        angle: this._markToAngle(
+          stop,
+          itemsSpec.minValue,
+          itemsSpec.maxValue,
+          itemsSpec[data.label.eng].circle.angles,
+          itemsSpec[data.label.eng].circle.direction
+        ),
+      })),
+    }));
+
+    return [{ items }];
+  }
+
+  _markToAngle(mark, min, max, angles, direction) {
+    const totalAngle = this._calcDiffAngle(angles.end, angles.start, direction);
+    const deltaTheta = ((mark - min) / (max - min)) * totalAngle;
+    return this._calcDistAngle(deltaTheta, angles.start, direction);
+  }
+
+  _calcDiffAngle(theta, theta0, direction) {
+    return direction ? 2 * Math.PI - (theta - theta0) : theta - theta0;
+  }
+
+  _calcDistAngle(deltaTheta, theta0, direction) {
+    return direction ? 2 * Math.PI - deltaTheta + theta0 : deltaTheta + theta0;
+  }
+}
+
+module.exports = STAIY93;