feat!: rename xyXShift to xyCalibrate

mljs · Jan 19, 2021 · eb04e3d · eb04e3d
1 parent 0765848
commit eb04e3d
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/src/index.js b/src/index.js
@@ -83,7 +83,7 @@ export * from './xy/xyReduce';
 export * from './xy/xyRolling';
 export * from './xy/xyToXYObject';
 export * from './xy/xyToXYArray';
-export * from './xy/xyXShift';
+export * from './xy/xyCalibrate';
 export * from './xy/xyUniqueX';
 export * from './xy/xySortX';
 

diff --git a/src/xy/__tests__/xyXShift.test.js → src/xy/__tests__/xyCalibrate.js b/src/xy/__tests__/xyXShift.test.js → src/xy/__tests__/xyCalibrate.js
@@ -1,13 +1,13 @@
-import { xyXShift } from '../xyXShift.js';
+import { xyCalibrate } from '../xyCalibrate.js';
 
-describe('xyXShift', function () {
+describe('xyCalibrate', function () {
   it('undefined params', () => {
     let data = {
       x: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12],
       y: [1, 1, 5, 1, 1, 1, 700, 1, 1, 1, 1, 1, 1],
     };
 
-    let xShift = xyXShift(data);
+    let xShift = xyCalibrate(data);
 
     expect(xShift).toBe(0);
   });
@@ -18,7 +18,7 @@ describe('xyXShift', function () {
       y: [1, 1, 5, 1],
     };
 
-    expect(() => xyXShift(data, { from: 1, to: 10 })).toThrow(
+    expect(() => xyCalibrate(data, { from: 1, to: 10 })).toThrow(
       'Window size is higher than the data lengt',
     );
   });
@@ -39,7 +39,7 @@ describe('xyXShift', function () {
       },
     };
 
-    let xShift = xyXShift(
+    let xShift = xyCalibrate(
       data,
       { from: 1, to: 10 },
       {
@@ -67,7 +67,7 @@ describe('xyXShift', function () {
       },
     };
 
-    let xShift = xyXShift(
+    let xShift = xyCalibrate(
       data,
       { from: 1, to: 10 },
       {

diff --git a/src/xy/xyXShift.js → src/xy/xyCalibrate.js b/src/xy/xyXShift.js → src/xy/xyCalibrate.js
@@ -4,7 +4,7 @@ import { gsd } from 'ml-gsd';
 import { xFindClosestIndex } from '../x/xFindClosestIndex';
 
 /**
- * Aligns the data based on a range and means of peaks in this range
+ * Calibrates the data based on a range and means of peaks in this range
  * Based on a range we will make a peak picking using global spectra deconvolution
  * The selected nbPeaks will then be taken into account to calculate an average X value.
  * The difference between the targetX and the averageX value will be returned
@@ -20,7 +20,7 @@ import { xFindClosestIndex } from '../x/xFindClosestIndex';
  * @returns {number} difference between targetX and currentX
  */
 
-export function xyXShift(data, range = {}, options = {}) {
+export function xyCalibrate(data, range = {}, options = {}) {
   const {
     targetX = 0,
     nbPeaks = 1,