@baravak/risloo-profile-cli 3.1.0

package/src/samples/DSWLS93.js

@@ -0,0 +1,112 @@
+const { Profile, FS } = require("../Profile");
+
+class DSWLS93 extends Profile {
+  // Number of pages
+  static pages = 1;
+
+  // Labels of the sample
+  labels = {
+    L1: { 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: 460 + 2 * this.padding.x,
+          height: 460 + 2 * this.padding.y,
+        }
+      },
+      padding: {
+        x: 0,
+        y: 127,
+      },
+    },
+    /* "raw" is the general term used for total data element in the profile */
+    raw: {
+      maxValue: 35 /* Maximum value of raw mark provided by the dataset */,
+      fill: "#16A34A" /* Color used in the raw element */,
+      circle: {
+        R: 230 /* Radius of the outer circle of the raw element */,
+        r: 160 /* Radius of the inner circle of the raw element */,
+        brs: {
+          tl: 20 /* Top left border radius */,
+          bl: 20 /* Bottom left border radius */,
+          tr: 20 /* Top right border radius */,
+          br: 20 /* Bottom right border radius */,
+        } /* Border radiuses at each end of the gauge of the raw element */,
+        angles: {
+          start: FS.toRadians(-90),
+          end: FS.toRadians(180),
+        } /* Angles of each end of the raw element */,
+        direction: false /* Clockwise direction for the raw gauge element */,
+        get totalAngle() {
+          return this.direction
+            ? 2 * Math.PI - (this.angles.end - this.angles.start)
+            : this.angles.end - this.angles.start;
+        },
+      },
+      ticks: {
+        num: 2 /* Number of ticks */,
+        number: {
+          offset: 25 /* Offset from the line */,
+        },
+      },
+    },
+    /* "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 } = spec;
+
+    const rawData = dataset.score[0];
+
+    // Calculate Ticks Numbers Array for Raw
+    const rawTicksNumbers = FS.createArithmeticSequence(
+      rawSpec.maxValue,
+      -rawSpec.maxValue / (rawSpec.ticks.num - 1),
+      rawSpec.ticks.num
+    ).reverse();
+
+    // Gather Required Info for Raw
+    const raw = {
+      label: rawData.label,
+      mark: rawData.mark,
+      zeta: (rawData.mark / rawSpec.maxValue) * rawSpec.circle.totalAngle + rawSpec.circle.angles.start,
+      fill: rawSpec.fill,
+      opacity: FS.roundTo2(0.5 * (1 + rawData.mark / rawSpec.maxValue)),
+      ticks: rawTicksNumbers.map((tick) => ({
+        number: tick,
+        angle: (tick / rawSpec.maxValue) * rawSpec.circle.totalAngle + rawSpec.circle.angles.start,
+      })),
+    };
+
+    return [{ raw }];
+  }
+}
+
+module.exports = DSWLS93;

package/src/samples/EMSS93.js

@@ -0,0 +1,178 @@
+const { Profile, FS } = require("../Profile");
+
+class EMSS93 extends Profile {
+  // Number of pages
+  static pages = 1;
+
+  // Labels of the sample
+  labels = {
+    L1: { eng: "raw", fr: "نمره کل" },
+    L2: { eng: "t_score", fr: "نمره t" },
+    L3: { eng: "t_score_summary", fr: "خلاصه نمره t" },
+    L4: { eng: "personality_issues", fr: "موضوعات شخصیتی" },
+    L5: { eng: "religious_orientation", fr: "جهت‌گیری مذهبی" },
+    L6: { eng: "family_and_friends", fr: "اقوام و دوستان" },
+    L7: { eng: "children_and_marriage", fr: "ازدواج و فرزندان" },
+    L8: { eng: "sexual_relationship", fr: "روابط جنسی" },
+    L9: { eng: "leisure_activities", fr: "فعالیت‌های اوقات فراغت" },
+    L10: { eng: "financial_management", fr: "مدیریت مالی" },
+    L11: { eng: "Conflict_resolution", fr: "حل تعارض" },
+    L12: { eng: "marital_communication", fr: "ارتباط زناشویی" },
+    L13: { eng: "personality_issues_interpretation", fr: "تفسیر موضوعات شخصیتی" },
+    L14: { eng: "religious_orientation_interpretation", fr: "تفسیر جهت‌گیری مذهبی" },
+    L15: { eng: "family_and_friends_interpretation", fr: "تفسیر اقوام و دوستان" },
+    L16: { eng: "children_and_marriage_interpretation", fr: "تفسیر ازدواج و فرزندان" },
+    L17: { eng: "sexual_relationship_interpretation", fr: "تفسیر روابط جنسی" },
+    L18: { eng: "leisure_activities_interpretation", fr: "تفسیر فعالیت‌های اوقات فراغت" },
+    L19: { eng: "financial_management_interpretation", fr: "تفسیر مدیریت مالی" },
+    L20: { eng: "Conflict_resolution_interpretation", fr: "تفسیر حل تعارض" },
+    L21: { eng: "marital_communication_interpretation", 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: 770 + 2 * this.padding.x,
+          height: 662 + 2 * this.padding.y,
+        }
+      },
+      padding: {
+        x: 0,
+        y: 20,
+      },
+    },
+    raw: {
+      stops: [11, 29, 40, 60, 70, 72],
+      rect: {
+        width: 30,
+        brs: {
+          tl: 0 /* Top left border radius */,
+          bl: 0 /* Bottom left border radius */,
+          tr: 4 /* Top right border radius */,
+          br: 4 /* Bottom right border radius */,
+        },
+        opacity: {
+          chosen: 0.8,
+          default: 0.3,
+        },
+      },
+      heightCoeff: 7.5,
+      label: {
+        shape: {
+          width: 61,
+          height: 46,
+        },
+      },
+    },
+    circles: {
+      n: 9 /* Number of vertices of the polygons */,
+      get theta() {
+        return (2 * Math.PI) / this.n;
+      },
+      startAngle: FS.toRadians(-70) /* Start angle of the polygon */,
+      radiuses: [50, 90, 130, 170, 210, 250] /* Radiuses array of circles */,
+      get wholeRadius() {
+        let len = this.radiuses.length;
+        return this.radiuses[len - 1] - this.radiuses[0];
+      },
+    },
+    /* "items" is the general term used for independent data elements to be drawn in the profile */
+    items: {
+      maxValues: {
+        [this.labels.L4.eng]: 30,
+        [this.labels.L5.eng]: 25,
+        [this.labels.L6.eng]: 25,
+        [this.labels.L7.eng]: 25,
+        [this.labels.L8.eng]: 25,
+        [this.labels.L9.eng]: 25,
+        [this.labels.L10.eng]: 25,
+        [this.labels.L11.eng]: 25,
+        [this.labels.L12.eng]: 30,
+      } /* Maximum values of marks provided by the dataset */,
+      circle: {
+        r: 50,
+        brs: {
+          tl: 4 /* Top left border radius */,
+          bl: 0 /* Bottom left border radius */,
+          tr: 4 /* Top right border radius */,
+          br: 0 /* Bottom right border radius */,
+        } /* Border radiuses at each end of the gauge of the items element */,
+        direction: false /* Clockwise direction for the items gauge element */,
+        totalAngle: FS.toRadians(32),
+        opacity: 0.8,
+      },
+      labels: {
+        offset: 50 /* Offset of the label from the vertice of the polygon */,
+      },
+      interprets: [
+        { fill: "#EF4444", eng: "severe_dissatisfaction", fr: "نارضایتی شدید" },
+        { fill: "#FBBF24", eng: "dissatisfaction", fr: "عدم رضایت" },
+        { fill: "#9CA3AF", eng: "moderate_satisfaction", fr: "رضایت نسبی و متوسط" },
+        { fill: "#38BDF8", eng: "severe_satisfaction", fr: "رضایت زیاد" },
+        { fill: "#22C55E", eng: "extreme_satisfaction", 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
+    let { circles: circlesSpec, items: itemsSpec } = spec;
+
+    const rawData = dataset.score.slice(0, 3);
+    const itemsData = dataset.score.slice(3, 12);
+    const interpretsData = dataset.score.slice(12);
+
+    const raw = {
+      label: rawData[0].label,
+      mark: rawData[0].mark,
+      tScore: rawData[1].mark,
+      tScoreIndex: itemsSpec.interprets.findIndex((interpretation) => interpretation.eng === rawData[2].mark) + 1,
+      get fill() {
+        return itemsSpec.interprets[this.tScoreIndex - 1].fill;
+      },
+    };
+
+    const items = itemsData.map((data, dataIndex) => ({
+      label: data.label,
+      mark: data.mark,
+      angle: circlesSpec.startAngle - dataIndex * circlesSpec.theta,
+      tScore:
+        itemsSpec.interprets.findIndex((interpretation) => interpretation.eng === interpretsData[dataIndex].mark) + 1,
+      get radius() {
+        return circlesSpec.radiuses.slice(1)[this.tScore - 1];
+      },
+      get fill() {
+        return itemsSpec.interprets[this.tScore - 1].fill;
+      },
+    }));
+
+    return [{ raw, items }];
+  }
+}
+
+module.exports = EMSS93;

package/src/samples/FACES93.js

@@ -0,0 +1,225 @@
+const { Profile } = require("../Profile");
+
+class FACES93 extends Profile {
+  // Number of pages
+  static pages = 2;
+
+  // Labels of the sample
+  labels = {
+    L1: {
+      eng: "a",
+      fr: "منسجم متعادل",
+    },
+    L2: {
+      eng: "c",
+      fr: "از هم گسسته",
+    },
+    L3: {
+      eng: "d",
+      fr: "در هم تنیده",
+    },
+    L4: {
+      eng: "e",
+      fr: "خشک",
+    },
+    L5: {
+      eng: "f",
+      fr: "آشفته",
+    },
+    L6: {
+      eng: "b",
+      fr: "انعطاف‌پذیر متعادل",
+    },
+    L7: {
+      eng: "communication",
+      fr: "برقراری ارتباط در خانواده",
+    },
+    L8: {
+      eng: "satisfaction",
+      fr: "رضایت خانواده",
+    },
+    L9: {
+      eng: "cohesion",
+      fr: "انسجام",
+    },
+    L10: {
+      eng: "flexibility",
+      fr: "انعطاف‌پذیری",
+    },
+    L11: {
+      eng: "interpretation",
+      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: "پرسشنامه FACES-III" /* Name of the sample */,
+      multiProfile: true /* 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: [
+        "job",
+        "marriage_duration",
+        { merge: ["sons", "daughters"], fr: "تعداد فرزندان (دختر / پسر)", valueFormat: "{1} دختر / {0} پسر" },
+        "religion",
+      ] /* 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: 825 + 2 * this.padding[0].x,
+            height: 605 + 2 * this.padding[0].y,
+          },
+          {
+            width: 802 + 2 * this.padding[1].x,
+            height: 537.5 + 2 * this.padding[1].y,
+          },
+        ];
+      },
+      padding: [
+        {
+          x: 36.75,
+          y: 0,
+        },
+        {
+          x: 52,
+          y: 0,
+        },
+      ],
+    },
+    page2: {
+      /* "items" is the general term used for independent data elements to be drawn in the profile */
+      items: {
+        top: {
+          baseline: {
+            width: 800 /* Width of the baseline below items */,
+          },
+          maxValue: 35 /* Maximum value of items marks provided by the dataset */,
+          topPos: 353.25 /* Top position of the baseline of items */,
+          offsetX: 75 /* Horizontal offset between two consecutive item */,
+          get distanceX() {
+            return this.offsetX + this.rect.body.width;
+          } /* Horizontal distance between two consecutive item */,
+          rect: {
+            base: {
+              width: 4 /* Width of the base rectangle of items */,
+              br: 2 /* Border radius of the base rectangle of items */,
+              color: "#E4E4E7" /* Fill of the base rectangle */,
+            },
+            body: {
+              width: 35 /* Width of the body rectangle of items */,
+              height: 8 /* Height of the body rectangle parts of items */,
+              offsetY: 1 /* Vertical offset between two parts of body rectangles */,
+              get distanceY() {
+                return this.height + this.offsetY;
+              } /* Vertical distance between two parts of body rectangles */,
+              br: 4 /* Border radius of the body rectangle of items */,
+              colors: [
+                "#A21CAF",
+                "#C026D3",
+                "#D946EF",
+                "#A855F7",
+                "#9333EA",
+                "#7E22CE",
+              ] /* Colors used for theming items body parts */,
+            },
+            heightCoeff: 9.28 /* Used to convert mark to height for base rectangle of items */,
+          },
+        },
+        bottom: {
+          maxValue: 50 /* Maximum value of raw mark provided by the dataset */,
+          offsetY: 112.25 /* Vertical offset from items */,
+          rect: {
+            base: {
+              width: 600 /* Width of the base rectangle of the raw */,
+              height: 4 /* Height of the base rectangle of the raw */,
+              br: 2 /* Border radius of the base rectangle of the raw */,
+            },
+            body: {
+              height: 27 /* Height of the body rectangle of the raw */,
+              br: 8 /* Border radius of the body rectangle of the raw */,
+            },
+          },
+          widthCoeff: 12 /* Used for converting mark to the width */,
+        },
+      },
+    },
+    /* "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 { page2: page2Spec } = spec;
+
+    // Gather Required Info for Item (Page 1)
+    const page1Item = {
+      marks: {
+        cohesion: dataset.score[8].mark,
+        flexibility: dataset.score[9].mark,
+      },
+      coords: {
+        x: this._markToCoord(dataset.score[8].mark, 120),
+        y: this._markToCoord(dataset.score[9].mark, 80),
+      },
+    };
+
+    // Gather Required Info for Items (Page 2)
+    const page2Items = {
+      top: dataset.score.slice(0, 6).map((data, index) => ({
+        label: data.label,
+        mark: data.mark,
+        maxValue: page2Spec.items.top.maxValue,
+        height: {
+          base: page2Spec.items.top.maxValue * page2Spec.items.top.rect.heightCoeff + 5,
+        },
+        fill: page2Spec.items.top.rect.body.colors[index],
+      })),
+      bottom: dataset.score.slice(6, 8).map((data) => ({
+        label: data.label,
+        mark: data.mark,
+        width: data.mark * page2Spec.items.bottom.widthCoeff,
+      })),
+    };
+
+    return [
+      { page: 1, item: page1Item },
+      { page: 2, items: page2Items },
+    ];
+  }
+
+  _markToCoord(mark, coeff) {
+    const stops = [0, 15, 35, 65, 85, 100];
+    const n = stops.length;
+    let index;
+
+    for (let i = 0; i < n; i++) {
+      if (mark >= stops[i] && mark <= stops[i + 1]) {
+        index = i;
+        break;
+      }
+    }
+
+    const coord = index * coeff + ((mark - stops[index]) / (stops[index + 1] - stops[index])) * coeff;
+
+    return coord;
+  }
+}
+
+module.exports = FACES93;

package/src/samples/FTEPT93.js

@@ -0,0 +1,167 @@
+const { Profile } = require("../Profile");
+
+class FTEPT93 extends Profile {
+  // Number of pages
+  static pages = 1;
+
+  // Labels of the sample
+  labels = {
+    L1: { eng: "raw", fr: "نمره کل" },
+    L2: { eng: "efficacy", fr: "خودکارآمدی" },
+    L3: { eng: "emotional_effects", fr: "تأثیرات\nهیجانی" },
+    L4: { eng: "planning", fr: "برنامه‌ریزی" },
+    L5: { eng: "lack_of_consequence_control", fr: "فقدان\nکنترل پیامد" },
+    L6: { eng: "motivation", fr: "انگیزش" },
+    L7: { eng: "interpretation", 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: [
+        "study_field",
+        "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: 740 + 2 * this.padding.x,
+          height: 632 + 2 * this.padding.y,
+        }
+      },
+      padding: {
+        x: 0,
+        y: 40,
+      },
+    },
+    /* "raw" is the general term used for total data element in the profile */
+    raw: {
+      maxValue: 240 /* Maximum value of raw mark provided by the dataset */,
+      leftPos: 10 /* Left position of the raw rectangle */,
+      offsetY: 150 /* Vertical offset from items */,
+      rect: {
+        width: 720 /* Width of the raw rectangle */,
+        height: 20 /* Height of the raw rectangle */,
+        br: 5 /* Border radius of the raw rectangle */,
+      },
+      widthCoeff: 3 /* Used for converting mark to the width */,
+      stops: [48, 95, 143, 240] /* Stops array for the raw mark */,
+      interprets: [
+        { fill: "#EF4444", eng: "weak", fr: "ضعیف" },
+        { fill: "#FBBF24", eng: "mild", fr: "متوسط" },
+        { fill: "#22C55E", eng: "very_good", fr: "بسیار خوب" },
+      ] /* Interprets array for the raw mark */,
+      label: {
+        stops: {
+          line: {
+            length: 32,
+          },
+          number: {
+            offsetY: 15,
+          },
+        },
+        shape: {
+          width: 50,
+          height: 41.5,
+          offsetY: 35,
+        },
+      },
+    },
+    /* "items" is the general term used for independent data elements to be drawn in the profile */
+    items: {
+      baseline: {
+        width: 740 /* Width of the baseline below items */,
+      },
+      maxValues: {
+        [this.labels.L2.eng]: 40,
+        [this.labels.L3.eng]: 40,
+        [this.labels.L4.eng]: 70,
+        [this.labels.L5.eng]: 25,
+        [this.labels.L6.eng]: 65,
+      } /* Maximum values of items marks provided by the dataset */,
+      topPos: 425 /* Top position of the baseline of items */,
+      offsetX: 100 /* Horizontal offset between two consecutive item */,
+      get distanceX() {
+        return this.offsetX + this.rect.body.width;
+      } /* Horizontal distance between two consecutive item */,
+      rect: {
+        base: {
+          width: 10 /* Width of the base rectangle of items */,
+          br: 2 /* Border radius of the base rectangle of items */,
+          color: "#F4F4F5" /* Fill of the base rectangle */,
+        },
+        body: {
+          width: 35 /* Width of the body rectangle of items */,
+          br: 6 /* Border radius of the body rectangle of items */,
+          colors: [
+            "#C026D3",
+            "#EC4899",
+            "#3B82F6",
+            "#14B8A6",
+            "#65A30D",
+          ] /* Colors used for theming items body parts */,
+        },
+        heightCoeff: 6 /* Used for converting mark to the height */,
+      },
+    },
+    /* "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
+    let rawData = dataset.score.shift();
+
+    // Separate Interpretation from the Dataset
+    let interpret = dataset.score.pop().mark;
+
+    // Gather Required Info for Raw
+    const raw = {
+      mark: rawData.mark,
+      label: rawData.label,
+      width: rawData.mark * rawSpec.widthCoeff,
+      interpret: rawSpec.interprets.find((interpretation) => interpretation.eng === interpret),
+      stops: rawSpec.stops.map((stop) => ({
+        mark: stop,
+        width: stop * rawSpec.widthCoeff,
+      })),
+    };
+
+    // Gather Required Info for Items
+    const items = dataset.score.map((data, index) => ({
+      label: data.label,
+      mark: data.mark,
+      maxValue: itemsSpec.maxValues[data.label.eng],
+      height: {
+        base: itemsSpec.maxValues[data.label.eng] * itemsSpec.rect.heightCoeff,
+        body: data.mark * itemsSpec.rect.heightCoeff,
+      },
+      fill: itemsSpec.rect.body.colors[index],
+    }));
+
+    return [{ raw, items }];
+  }
+}
+
+module.exports = FTEPT93;