@baravak/risloo-profile-cli 3.1.0

package/src/samples/MMFAD93.js

@@ -0,0 +1,135 @@
+const { Profile, FS } = require("../Profile");
+
+class MMAFD93 extends Profile {
+  // Number of pages
+  static pages = 1;
+
+  // Labels of the sample
+  labels = {
+    L1: { eng: "raw", fr: "نمره کل" },
+    L2: { eng: "problem_solving", fr: "حل مشکل" },
+    L3: { eng: "overall_performance", fr: "عملکرد کلی" },
+    L4: { eng: "behaviour_control", fr: "کنترل رفتار" },
+    L5: { eng: "affective_involvement", fr: "آمیزش عاطفی" },
+    L6: { eng: "communication", fr: "ارتباط" },
+    L7: { eng: "affective_responsiveness", fr: "همراهی عاطفی" },
+    L8: { eng: "roles", 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: 705 + 2 * this.padding.x,
+          height: 653 + 2 * this.padding.y,
+        }
+      },
+      padding: {
+        x: 0,
+        y: 40,
+      },
+    },
+    /* Spec for the polygons drawn in the profile */
+    polygons: {
+      n: 7 /* Number of vertices of the polygons */,
+      get theta() {
+        return (2 * Math.PI) / this.n;
+      },
+      startAngle: FS.toRadians(-90) /* Start angle of the polygon */,
+      radius: 270 /* Radius of the peripheral circle of the main polygon */,
+      centerOffset: 67 /* Radius of the peropheral circle of the smallest polygon */,
+    },
+    /* "raw" is the general term used for total data element in the profile */
+    raw: {
+      maxValue: 256,
+      mark: {
+        paddingY: 18,
+      },
+    },
+    /* "items" is the general term used for independent data elements to be drawn in the profile */
+    items: {
+      maxValues: {
+        [this.labels.L2.eng]: 20,
+        [this.labels.L3.eng]: 60,
+        [this.labels.L4.eng]: 40,
+        [this.labels.L5.eng]: 40,
+        [this.labels.L6.eng]: 30,
+        [this.labels.L7.eng]: 35,
+        [this.labels.L8.eng]: 40,
+      } /* Maximum value of marks provided by the dataset */,
+      labels: {
+        offset: 50 /* Offset of the label from the vertice of the polygon */,
+        paddingY: 12 /* Half distance between two parts of the label */,
+      },
+      dataPoints: {
+        radius: 12 /* Radius of the circle of the data point */,
+        fills: {
+          [this.labels.L2.eng]: "#F59E0B",
+          [this.labels.L3.eng]: "#DB2777",
+          [this.labels.L4.eng]: "#9333EA",
+          [this.labels.L5.eng]: "#2563EB",
+          [this.labels.L6.eng]: "#059669",
+          [this.labels.L7.eng]: "#DC2626",
+          [this.labels.L8.eng]: "#71717A",
+        } /* Colors used for theming data points */,
+      },
+    },
+    /* "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 { polygons: polygonsSpec, items: itemsSpec } = spec;
+
+    const rawData = dataset.score.shift();
+
+    const raw = {
+      label: rawData.label,
+      mark: rawData.mark,
+    };
+
+    // Gather Required Info for Items
+    const items = dataset.score.map((data, index) => ({
+      label: data.label,
+      mark: data.mark,
+      maxValue: itemsSpec.maxValues[data.label.eng],
+      angle: polygonsSpec.startAngle - index * polygonsSpec.theta,
+      radius:
+        (data.mark / itemsSpec.maxValues[data.label.eng]) * (polygonsSpec.radius - polygonsSpec.centerOffset) +
+        polygonsSpec.centerOffset,
+      fill: itemsSpec.dataPoints.fills[data.label.eng],
+    }));
+
+    return [
+      {
+        raw,
+        items,
+      },
+    ];
+  }
+}
+
+module.exports = MMAFD93;

package/src/samples/MMFAD9A.js

@@ -0,0 +1,31 @@
+const MMAFD93 = require("./MMFAD93");
+
+const customConfig = {
+  test: {
+    name: "پرسشنامه عملکرد خانواده ۶۰ سؤالی" /* Name of the test */,
+  },
+  raw: {
+    maxValue: 240,
+  },
+  items: {
+    maxValues: {
+      problem_solving: 24,
+      roles: 36,
+      affective_responsiveness: 28,
+      communication: 28,
+      affective_involvement: 36,
+      behaviour_control: 36,
+      overall_performance: 52,
+    } /* Maximum value of marks provided by the dataset */,
+  },
+};
+
+// This profile is completely identical to MMFAD93
+
+class MMFAD9A extends MMAFD93 {
+  constructor(dataset, options, config = customConfig) {
+    super(dataset, options, config);
+  }
+}
+
+module.exports = MMFAD9A;

package/src/samples/MOCI93.js

@@ -0,0 +1,128 @@
+const { Profile } = require("../Profile");
+
+class MOCI93 extends Profile {
+  // Number of pages
+  static pages = 1;
+
+  // Labels of the sample
+  labels = {
+    L1: { eng: "washing", fr: "شستشو", abbr: "W" },
+    L2: { eng: "control", fr: "وارسی", abbr: "C" },
+    L3: { eng: "slowing_repeat", fr: "کندی - تکرار", abbr: "SR" },
+    L4: { eng: "doubt", fr: "تردید", abbr: "D" },
+    L5: { eng: "total", fr: "نمره کل", abbr: "T" },
+  };
+
+  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: 620 + 2 * this.padding.x,
+          height: 586 + 2 * this.padding.y,
+        }
+      },
+      padding: {
+        x: 15,
+        y: 50,
+      },
+    },
+    /* "raw" is the general term used for total data element in the profile */
+    raw: {
+      offsetX: 110 /* Horizontal offset between raw and last item */,
+      get distanceX() {
+        return this.offsetX + this.rect.width;
+      } /* Horizontal distance between raw and last item */,
+      rect: {
+        width: 60 /* Width of the raw rectangle */,
+        height: 30 /* Height of the raw rectangle */,
+        offsetY: 2 /* Vertical offset between two consecutive raw rectangles */,
+        get distanceY() {
+          return this.height + this.offsetY;
+        } /* Vertical Distance between two consecutive raw rectangles */,
+        defaultColor: "#F3F4F6" /* Default color of the raw rectangle */,
+        color: "#831843" /* Focused color of the raw rectangle */,
+      },
+      maxValue: 30 /* Maximum value of raw mark provided by the dataset */,
+      step: 2 /* Step is used to divide the mark in drawing the profile */,
+    },
+    /* "items" is the general term used for independent data elements to be drawn in the profile */
+    items: {
+      offsetX: 80 /* Horizontal offset between two consecutive item */,
+      get distanceX() {
+        return this.offsetX + this.rect.width;
+      } /* Horizontal distance between two consecutive item */,
+      rect: {
+        width: 50 /* Width of the items rectangle */,
+        height: 30 /* Height of the items rectangle */,
+        offsetY: 2 /* Vertical offset between two consecutive items rectangle */,
+        get distanceY() {
+          return this.height + this.offsetY;
+        } /* Vertical distance between two consecutive items rectangle */,
+        defaultColor: "#F3F4F6" /* Default color of the items rectangle */,
+        colors: ["#4C1D95", "#1E3A8A", "#374151", "#92400E"] /* Colors used for theming items */,
+      },
+      maxValues: {
+        [this.labels.L1.eng]: 11,
+        [this.labels.L2.eng]: 9,
+        [this.labels.L3.eng]: 7,
+        [this.labels.L4.eng]: 7,
+      } /* Maximum values of items marks provided by the dataset */,
+      step: 1 /* Step is used to divide the mark in drawing the profile */,
+    },
+    /* "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: {
+        maxValues,
+        rect: { colors },
+      },
+    } = spec;
+
+    // Separate Raw Data from the Dataset
+    const rawData = dataset.score.pop();
+
+    // Gather Required Info for Raw
+    const raw = {
+      label: rawData.label,
+      mark: rawData.mark,
+    };
+
+    // Gather Required Info for Items
+    const items = dataset.score.map((data, index) => ({
+      label: data.label,
+      mark: data.mark,
+      maxValue: maxValues[data.label.eng],
+      fill: colors[index],
+    }));
+
+    return [{ items, raw }];
+  }
+}
+
+module.exports = MOCI93;

package/src/samples/OBQ4493.js

@@ -0,0 +1,132 @@
+const { Profile } = require("../Profile");
+
+class OBQ4493 extends Profile {
+  // Number of pages
+  static pages = 1;
+
+  // Labels of the sample
+  labels = {
+    L1: { eng: "complete_performance", fr: "عملکرد کامل", abbr: "CP" },
+    L2: { eng: "importance_and_control_of_thought", fr: "اهمیت و کنترل فکر", abbr: "ICT" },
+    L3: { eng: "responsibility_and_threat_estimation", fr: "مسئولیت و تخمین تهدید", abbr: "RT" },
+    L4: { eng: "perfectionism_certainty", fr: "کمال‌گرایی / یقین", abbr: "PC" },
+    L5: { eng: "general", fr: "عمومی", abbr: "G" },
+    L6: { eng: "raw", fr: "مجموع", abbr: "T" },
+  };
+
+  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: 903 + 2 * this.padding.x,
+          height: 708 + 2 * this.padding.y,
+        }
+      },
+      padding: {
+        x: 0,
+        y: 0,
+      },
+    },
+    /* "raw" is the general term used for total data element in the profile */
+    raw: {
+      labels: {
+        offsetY: 18,
+      },
+      maxValuesOffsetX: 10,
+      maxValue: 132,
+      rect: {
+        width: 800,
+        height: 48,
+        br: 5,
+        offsetY: 100,
+      },
+    },
+    /* "items" is the general term used for independent data elements to be drawn in the profile */
+    items: {
+      labels: {
+        offsetY: 18,
+      },
+      maxValuesOffsetX: 10,
+      maxValues: {
+        [this.labels.L1.eng]: 15,
+        [this.labels.L2.eng]: 16,
+        [this.labels.L3.eng]: 21,
+        [this.labels.L4.eng]: 30,
+        [this.labels.L5.eng]: 48,
+      },
+      rect: {
+        width: 800,
+        height: 30,
+        br: 5,
+        offsetY: 70,
+        get distanceY() {
+          return this.height + this.offsetY;
+        },
+      },
+    },
+    separator: {
+      line: {
+        width: 903,
+        offsetY: 72.5,
+      },
+      desc: {
+        offsetY: 17.5,
+      },
+    },
+    /* "labels" part which has to be provided for each profile */
+    labels: Object.values(this.labels),
+    desc: "این آزمون هر چقدر به سمت مثبت برود، نشان‌دهنده باورهای وسواس بالاست و در صورت منفی بودن، باورهای وسواس پایین است.",
+  };
+
+  constructor(dataset, options, config = {}) {
+    super();
+    this._init(dataset, options, config);
+  }
+
+  _calcContext() {
+    const {
+      spec: { parameters: spec },
+      dataset,
+    } = this;
+
+    const { items: itemsSpec, raw: rawSpec } = spec;
+
+    // Separate Raw Data from the Dataset
+    const rawData = dataset.score.pop();
+
+    const raw = {
+      label: rawData.label,
+      mark: rawData.mark,
+      maxValue: rawSpec.maxValue,
+      width: Math.abs((rawData.mark / rawSpec.maxValue) * (rawSpec.rect.width / 2)),
+    };
+
+    const items = dataset.score.map((data) => ({
+      label: data.label,
+      mark: data.mark,
+      maxValue: itemsSpec.maxValues[data.label.eng],
+      width: Math.abs((data.mark / itemsSpec.maxValues[data.label.eng]) * (itemsSpec.rect.width / 2)),
+    }));
+
+    return [
+      {
+        raw,
+        items,
+      },
+    ];
+  }
+}
+
+module.exports = OBQ4493;

package/src/samples/PIES93.js

@@ -0,0 +1,228 @@
+const { Profile, FS, Mappings } = require("../Profile");
+
+class PIES93 extends Profile {
+  // Number of pages
+  static pages = 1;
+
+  // Labels of the sample
+  labels = {
+    L1: { eng: "hope", fr: "امید", abbr: "HO" },
+    L2: { eng: "will", fr: "اراده (خواسته)", abbr: "W" },
+    L3: { eng: "purpose", fr: "هدفمندی", abbr: "PU" },
+    L4: { eng: "competence", fr: "شایستگی", abbr: "CO" },
+    L5: { eng: "fidelity", fr: "صداقت (وفاداری)", abbr: "FI" },
+    L6: { eng: "love", fr: "عشق", abbr: "LO" },
+    L7: { eng: "care", fr: "مراقبت", abbr: "CA" },
+    L8: { eng: "wisdom", fr: "خرد (فرزانگی)", abbr: "WI" },
+    L9: { eng: "raw", fr: "نمره کل", abbr: "#" },
+  };
+
+  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: 821 + 2 * this.padding.x,
+          height: 610 + 2 * this.padding.y,
+        }
+      },
+      padding: {
+        x: 40,
+        y: 0,
+      },
+    },
+    /* "raw" is the general term used for total data element in the profile */
+    raw: {
+      maxValue: 160 /* Maximum value of raw mark provided by the dataset */,
+      offsetX: 120 /* Horizontal offset from items */,
+      ticks: {
+        num: 4 /* Number of ticks */,
+        line: {
+          width: 9 /* Width of the tick line */,
+          offsetX: 5 /* Horizontal offset from the rectangle */,
+        },
+        number: {
+          offsetX: 15 /* Horizontal Offset from the line */,
+        },
+      },
+      rect: {
+        width: 40 /* Width of the raw rectangle */,
+        height: 610 /* Height of the raw rectangle */,
+        get borderRadius() {
+          return this.width / 2;
+        } /* Border radius of the raw rectangle */,
+      },
+      label: {
+        circle: {
+          radius: 18 /* Radius of the circle in the label part */,
+        },
+        offsetY: 40 /* Vertical offset of the label from the circle */,
+      },
+      heightCoeff: 3.81 /* Used for converting mark to the height */,
+    },
+    /* "items" is the general term used for independent data elements to be drawn in the profile */
+    items: {
+      maxValue: 20 /* Maximum value of items mark provided by the dataset */,
+      offsetY: 30 /* Offset between two consecutive item in the profile */,
+      get distanceY() {
+        return this.offsetY + this.base.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.base.rect.height;
+      } /* Method for calculating the total height of items */,
+      ticks: {
+        num: 4 /* Number of ticks */,
+        heightOffset: 40 /* Half length that the ticks lines of items is greater than items total heigth */,
+        numberOffset: {
+          x: 15 /* Horizontal distance from the line */,
+          y: 10 /* Vertical distance from the line */,
+        },
+      },
+      body: {
+        rect: {
+          maxWidth: 400 /* Max width of the body part of items */,
+          brs: {
+            tl: 0 /* Top left border radius */,
+            bl: 0 /* Bottom left border radius */,
+            tr: 20 /* Top right border radius */,
+            br: 20 /* Bottom right border radius */,
+          } /* Border radiuses of the base rectangle */,
+        },
+        colors: [
+          "#8B5CF6",
+          "#EC4899",
+          "#10B981",
+          "#F59E0B",
+          "#007BA4",
+          "#EF4444",
+          "#6B7280",
+          "#047857",
+        ] /* Colors used for theming items body parts */,
+        opacityMappings: new Mappings()
+          .addMapping("1-5", 0.6)
+          .addMapping("6-10", 0.7)
+          .addMapping("11-15", 0.8)
+          .addMapping("16-19", 0.9)
+          .addMapping("20", 1) /* Opacity mapping for marks */,
+      },
+      base: {
+        rect: {
+          width: 220 /* Width of the items rectangle (base part) */,
+          height: 40 /* Height of the items rectangle (base part) */,
+          brs: {
+            tl: 20 /* Top left border radius */,
+            bl: 20 /* Bottom left border radius */,
+            tr: 0 /* Top right border radius */,
+            br: 0 /* Bottom right border radius */,
+          } /* Border radiuses of the base rectangle */,
+        },
+        label: {
+          circle: {
+            radius: 18 /* Radius of the circle in the label part */,
+          },
+          offsetX: 40 /* Horizontal offset of the label from the circle */,
+        },
+        colors: [
+          "#A27DF8",
+          "#F06DAD",
+          "#40C79A",
+          "#F7B13C",
+          "#3395B6",
+          "#F26969",
+          "#898E99",
+          "#369379",
+        ] /* Colors used for theming items base parts */,
+      },
+    },
+    /* "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.pop();
+    
+    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.maxValue) * rawSpec.rect.height,
+    };
+
+    // Gather Required Info for Items
+    const items = dataset.score.map((data, index) => ({
+      label: data.label,
+      width: (data.mark / itemsSpec.maxValue) * itemsSpec.body.rect.maxWidth,
+      mark: data.mark,
+      baseColor: itemsSpec.base.colors[index],
+      body: {
+        color: itemsSpec.body.colors[index],
+        opacity: itemsSpec.body.opacityMappings.map(data.mark),
+      },
+    }));
+
+    // Calculate Ticks Numbers Array for Raw
+    const rawTicksNumbers = FS.createArithmeticSequence(
+      rawSpec.maxValue,
+      -rawSpec.maxValue / rawSpec.ticks.num,
+      rawSpec.ticks.num
+    ).reverse();
+
+    // Gather Required Info for Raw Ticks
+    const rawTicks = rawTicksNumbers.map((tick) => ({
+      number: tick,
+      bottomPos: (tick / rawSpec.maxValue) * rawSpec.rect.height,
+    }));
+
+    // Calculate Ticks Numbers Array for Items
+    const itemsTicksNumbers = FS.createArithmeticSequence(
+      itemsSpec.maxValue,
+      -itemsSpec.maxValue / itemsSpec.ticks.num,
+      itemsSpec.ticks.num
+    ).reverse();
+
+    // Gather Required Info for Items Ticks
+    const itemsTicks = itemsTicksNumbers.map((tick) => ({
+      number: tick,
+      leftPos: (tick / itemsSpec.maxValue) * itemsSpec.body.rect.maxWidth,
+    }));
+
+    return [
+      {
+        raw,
+        items,
+        rawTicks,
+        itemsTicks,
+      },
+    ];
+  }
+}
+
+module.exports = PIES93;

package/src/samples/PIES9A.js

@@ -0,0 +1,32 @@
+const { Mappings } = require("../Profile");
+const PIES93 = require("./PIES93");
+
+const customConfig = {
+  sample: {
+    name: "پرسشنامه سياهه رواني - اجتماعي نيرومندي من (ايگو) فرم 64 سؤالي" /* Name of the sample */,
+  },
+  raw: {
+    maxValue: 320,
+  },
+  items: {
+    maxValue: 40,
+    body: {
+      opacityMappings: new Mappings()
+        .addMapping("8-9", 0.6)
+        .addMapping("10-19", 0.7)
+        .addMapping("20-29", 0.8)
+        .addMapping("30-39", 0.9)
+        .addMapping("40", 1),
+    },
+  },
+};
+
+// This profile is partially identical to PIES93
+
+class PIES9A extends PIES93 {
+  constructor(dataset, options, config = customConfig) {
+    super(dataset, options, config);
+  }
+}
+
+module.exports = PIES9A;