update date_range to dateRange and add docstring

Author: steveoni

src/danfojs-base/core/daterange.ts

@@ -130,6 +130,11 @@ class DateRange {
     return dateString
   }
 
+  /**
+   * @param date Date
+   * @param ftype string:  frequency type, month, Year, day etc
+   * @param number
+   */
   private freqType(date: Date, ftype: string): number{
     let rslt: number = 0;
     switch (ftype){
@@ -252,15 +257,15 @@ class DateRange {
 }
 
 /**
- * 
+ * Generate sequence of Dates 
  * @param start : signify the date to start with
  * @param end : signify the date to end with
  * @param period :  the total number of date to generate
  * @param offset : set the date range offset
  * @param freq: set the date range frequency and offset
  * @return string[]
  */
-export default function date_range(param: Params): string[] {
+export default function dateRange(param: Params): string[] {
   const dateRange = new DateRange(param)
   return dateRange.range()
 }

src/danfojs-base/index.ts

@@ -26,7 +26,7 @@ import OneHotEncoder from "./transformers/encoders/one.hot.encoder";
 import getDummies from "./transformers/encoders/dummy.encoder"
 import concat from "./transformers/concat"
 import merge from "./transformers/merge"
-import date_range from "./core/daterange"
+import dateRange from "./core/daterange"
 import tensorflow from "./shared/tensorflowlib"
 
 const __version = "1.0.0"
@@ -47,7 +47,7 @@ export {
     getDummies,
     concat,
     merge,
-    date_range,
+    dateRange,
     tensorflow,
     __version,
 }

src/danfojs-browser/src/index.ts

@@ -26,7 +26,7 @@ import {
     concat,
     merge,
     toDateTime,
-    date_range,
+    dateRange,
     tensorflow,
     __version,
 } from "../../danfojs-base";
@@ -67,7 +67,7 @@ export {
     getDummies,
     concat,
     merge,
-    date_range,
+    dateRange,
     tensorflow,
     __version,
 }

src/danfojs-node/src/index.ts

@@ -26,7 +26,7 @@ import {
     concat,
     merge,
     toDateTime,
-    date_range,
+    dateRange,
     tensorflow,
     __version
 } from "../../danfojs-base";
@@ -74,7 +74,7 @@ export {
     getDummies,
     concat,
     merge,
-    date_range,
+    dateRange,
     tensorflow,
     __version
 }

src/danfojs-node/test/core/daterange.test.ts

@@ -1,11 +1,11 @@
 import { assert } from "chai";
-import { date_range } from '../../dist/danfojs-node/src';
+import { dateRange } from '../../dist/danfojs-node/src';
 
 
-describe("date_range", function(){
+describe("dateRange", function(){
 
   // it("Obtain date between start and end specified", function(){
-  //   let d = date_range({start:'2018-04-24',end:'2018-04-27'})
+  //   let d = dateRange({start:'2018-04-24',end:'2018-04-27'})
   //   let rslt = [
   //     '4/24/2018, 1:00:00 AM',
   //     '4/25/2018, 1:00:00 AM',
@@ -15,7 +15,7 @@ describe("date_range", function(){
   //   assert.deepEqual(d,rslt)
   // });
   it("Obtain date between start with end not specified, but period and freq specified", function(){
-    let d = date_range({ start:'1/1/2018', period:5, freq:'M' });
+    let d = dateRange({ start:'1/1/2018', period:5, freq:'M' });
     let rslt = [
       '1/1/2018, 12:00:00 AM',
       '2/1/2018, 12:00:00 AM',
@@ -26,7 +26,7 @@ describe("date_range", function(){
     assert.deepEqual(d, rslt);
   });
   it("Obtain date between start with end not specified, but period and freq specified, plus offset", function(){
-    let d = date_range({ start:'1/1/2018', period:5, freq:'3M' });
+    let d = dateRange({ start:'1/1/2018', period:5, freq:'3M' });
     let rslt = [
       '1/1/2018, 12:00:00 AM',
       '4/1/2018, 12:00:00 AM',
@@ -37,7 +37,7 @@ describe("date_range", function(){
     assert.deepEqual(d, rslt);
   });
   it("Obtain date between start with end not specified, but period and freq specified, plus offset, longer freq", function(){
-    let d = date_range({ start:'1/1/2018', period:5, freq:'35m' });
+    let d = dateRange({ start:'1/1/2018', period:5, freq:'35m' });
     let rslt = [
       "1/1/2018, 12:00:00 AM",
       "1/1/2018, 12:35:00 AM",
@@ -48,7 +48,7 @@ describe("date_range", function(){
     assert.deepEqual(d, rslt);
   });
   it("Obtain date range with start not specified but end and period is given", function(){
-    let d = date_range({ end:'1/1/2018', period:8 });
+    let d = dateRange({ end:'1/1/2018', period:8 });
     let rslt = [
       '12/25/2017, 12:00:00 AM',
       '12/26/2017, 12:00:00 AM',
@@ -62,17 +62,17 @@ describe("date_range", function(){
     assert.deepEqual(d, rslt);
   });
   it("inputing wrong freq", function(){
-    assert.throws(function () { date_range({ end:'1/1/2018', period:8, freq:"d" }); }, Error, 'invalid freq d');
+    assert.throws(function () { dateRange({ end:'1/1/2018', period:8, freq:"d" }); }, Error, 'invalid freq d');
   });
   it("inputing wrong freq with offset", function(){
-    assert.throws(function () { date_range({ end:'1/1/2018', period:8, freq:"4d" }); }, Error, 'invalid freq d');
+    assert.throws(function () { dateRange({ end:'1/1/2018', period:8, freq:"4d" }); }, Error, 'invalid freq d');
   });
   it("inputing wrong freq offset", function(){
-    assert.throws(function () { date_range({ end:'1/1/2018', period:8, freq:"abcm" }); }, Error, 'invalid freq offset abc');
+    assert.throws(function () { dateRange({ end:'1/1/2018', period:8, freq:"abcm" }); }, Error, 'invalid freq offset abc');
   });
   // it("Obtain date between start and end specified with different month", function(){
 
-  //   let d = date_range({start:'2018-04-24',end:'2018-05-27'})
+  //   let d = dateRange({start:'2018-04-24',end:'2018-05-27'})
   //   let rslt = [
   //     '4/24/2018, 1:00:00 AM',
   //     '4/25/2018, 1:00:00 AM',