Skip to content

Commit d95e6bf

Browse files
risenWrisenW
committed
Update docstrings with examples
1 parent 98383d0 commit d95e6bf

9 files changed

Lines changed: 989 additions & 122 deletions

File tree

‎src/danfojs-base/core/frame.ts‎

Lines changed: 555 additions & 56 deletions
Large diffs are not rendered by default.

‎src/danfojs-base/core/series.ts‎

Lines changed: 400 additions & 32 deletions
Large diffs are not rendered by default.

‎src/danfojs-base/io/browser/io.csv.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ const $streamCSV = async (file: string, callback: (df: DataFrame) => void, optio
116116
* ```
117117
*/
118118
const $toCSV = (df: NDframe | DataFrame | Series, options?: CsvOutputOptionsBrowser): string | void => {
119-
let { fileName, download, sep, header } = { fileName: "output.csv", sep: ",", header: true, download: true, ...options }
119+
let { fileName, download, sep, header } = { fileName: "output.csv", sep: ",", header: true, download: false, ...options }
120120

121121
if (df.$isSeries) {
122122
const csv = df.values.join(sep);

‎src/danfojs-base/io/browser/io.json.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ const $readJSON = async (file: any, options?: JsonInputOptionsBrowser) => {
9393
* ```
9494
*/
9595
const $toJSON = (df: NDframe | DataFrame | Series, options?: JsonOutputOptionsBrowser): object | void => {
96-
let { fileName, format, download } = { fileName: "output.json", download: true, format: "column", ...options }
96+
let { fileName, format, download } = { fileName: "output.json", download: false, format: "column", ...options }
9797

9898
if (df.$isSeries) {
9999
const obj: { [key: string]: ArrayType1D } = {};

‎src/danfojs-base/shared/types.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ export interface SeriesInterface extends NDframeInterface {
135135
var(): number
136136
isNa(): Series
137137
fillNa(value: number | string | boolean, options?: { inplace?: boolean }): Series | void
138-
sortValues(ascending: boolean, options?: { inplace?: boolean }): Series | void
138+
sortValues(options?: { ascending?: boolean, inplace?: boolean }): Series | void
139139
copy(): Series
140140
describe(): Series
141141
resetIndex(options?: { inplace?: boolean }): Series | void
@@ -264,7 +264,7 @@ export interface DataFrameInterface extends NDframeInterface {
264264
inplace?: boolean
265265
}): DataFrame | void
266266
isNa(): DataFrame
267-
dropNa(axis?: 0 | 1, options?: { inplace?: boolean }): DataFrame | void
267+
dropNa(options?: { axis: 0 | 1, inplace?: boolean }): DataFrame | void
268268
apply(callable: any, options?: { axis?: 0 | 1 }): DataFrame | Series
269269
applyMap(callable: any, options?: { inplace?: boolean }): DataFrame | void
270270
lt(other: DataFrame | Series | number, options?: { axis?: 0 | 1 }): DataFrame

‎src/danfojs-browser/tests/core/frame.test.js‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1536,7 +1536,7 @@ describe("DataFrame", function () {
15361536
const df_val = [ [ 2, 4 ],
15371537
[ 180, 360 ],
15381538
[ 180, 360 ] ];
1539-
assert.deepEqual(df.dropNa(0).values, df_val);
1539+
assert.deepEqual(df.dropNa({ axis: 0 }).values, df_val);
15401540

15411541
});
15421542
it("drop NaNs along axis 1", function () {
@@ -1547,15 +1547,15 @@ describe("DataFrame", function () {
15471547
const df = new dfd.DataFrame(data, { columns: column });
15481548
const df_val = [ [ 0, 2, 4 ],
15491549
[ 360, 180, 360 ] ];
1550-
assert.deepEqual(df.dropNa(1).values, df_val);
1550+
assert.deepEqual(df.dropNa({ axis: 1 }).values, df_val);
15511551

15521552
});
15531553
it("drop NaNs along axis 1", function () {
15541554
const data = [ [ NaN, 1, 2, 3 ], [ 3, 4, NaN, 9 ], [ 5, 6, 7, 8 ] ];
15551555
const column = [ "A", "B", "C", "D" ];
15561556
const df = new dfd.DataFrame(data, { columns: column });
15571557
const df_val = [ [ 5, 6, 7, 8 ] ];
1558-
assert.deepEqual(df.dropNa(1).values, df_val);
1558+
assert.deepEqual(df.dropNa({ axis: 1 }).values, df_val);
15591559

15601560
});
15611561
it("drop inplace at axis 0, inplace false ", function () {
@@ -1565,7 +1565,7 @@ describe("DataFrame", function () {
15651565

15661566
const df_val = [ [ 1, 3 ], [ 4, 9 ], [ 6, 8 ] ];
15671567

1568-
assert.deepEqual(df.dropNa(0).values, df_val);
1568+
assert.deepEqual(df.dropNa({ axis: 0 }).values, df_val);
15691569

15701570
});
15711571
it("drop inplace at axis 0, inplace true ", function () {
@@ -1574,7 +1574,7 @@ describe("DataFrame", function () {
15741574
const df = new dfd.DataFrame(data, { columns: column });
15751575

15761576
const df_val = [ [ 1, 3 ], [ 4, 9 ], [ 6, 8 ] ];
1577-
df.dropNa(0, { inplace: true });
1577+
df.dropNa({ axis: 0, inplace: true });
15781578
assert.deepEqual(df.values, df_val);
15791579

15801580
});
@@ -1585,7 +1585,7 @@ describe("DataFrame", function () {
15851585

15861586
const df_val = [ [ 5, 6, 7, 8 ] ];
15871587

1588-
df.dropNa(1, { inplace: true });
1588+
df.dropNa({ axis: 1, inplace: true });
15891589
assert.deepEqual(df.values, df_val);
15901590

15911591
});
@@ -1597,7 +1597,7 @@ describe("DataFrame", function () {
15971597

15981598
let df_val = [ [ 5, 6, 7, 8 ] ];
15991599

1600-
df.dropNa(1, { inplace: true });
1600+
df.dropNa({ axis: 1, inplace: true });
16011601
assert.deepEqual(df.values, df_val);
16021602

16031603
});

‎src/danfojs-browser/tests/core/series.test.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -654,20 +654,20 @@ describe("Series Functions", () => {
654654
const sf = new dfd.Series([ 20, 30, 1, 2, 4, 57, 89, 0, 4 ]);
655655
const result = [ 0, 1, 2, 4, 4, 20, 30, 57, 89 ];
656656
const expectedIndex = [ 7, 2, 3, 8, 4, 0, 1, 5, 6 ];
657-
sf.sortValues(true, { inplace: true });
657+
sf.sortValues({ ascending:true, inplace: true });
658658
assert.deepEqual(sf.values, result);
659659
assert.deepEqual(sf.index, expectedIndex);
660660
});
661661
it("Sort values in a Series in Descending order", function () {
662662
const sf = new dfd.Series([ 20, 30, 1, 2, 4, 57, 89, 0, 4 ]);
663663
const result = [ 89, 57, 30, 20, 4, 4, 2, 1, 0 ];
664-
const sortedSf = sf.sortValues(false);
664+
const sortedSf = sf.sortValues({ ascending: false });
665665
assert.deepEqual(sortedSf.values, result);
666666
});
667667
it("confirms that sortValues in descending order happens inplace", function () {
668668
const sf = new dfd.Series([ 20, 30, 1, 2, 4, 57, 89, 0, 4 ]);
669669
const result = [ 89, 57, 30, 20, 4, 4, 2, 1, 0 ];
670-
sf.sortValues(false, { inplace: true });
670+
sf.sortValues({ ascending: false, inplace: true });
671671
assert.deepEqual(sf.values, result);
672672
});
673673
it("Confirms that series index is sorted in ascending order (not in inplace)", function () {
@@ -679,13 +679,13 @@ describe("Series Functions", () => {
679679
it("Confirms that series index is sorted in descending order (not in inplace)", function () {
680680
const sf = new dfd.Series([ 20, 30, 1, 2, 4, 57, 89, 0, 4 ]);
681681
const result = [ 6, 5, 1, 0, 4, 8, 3, 2, 7 ];
682-
const sortedSf = sf.sortValues(false);
682+
const sortedSf = sf.sortValues({ ascending: false });
683683
assert.deepEqual(sortedSf.index, result);
684684
});
685685
it("Sort string values in a Series", function () {
686686
const sf = new dfd.Series([ "boy", "zebra", "girl", "man" ]);
687687
const result = [ "boy", "girl", "man", "zebra" ];
688-
const sortedSf = sf.sortValues(false);
688+
const sortedSf = sf.sortValues({ ascending: false });
689689
assert.deepEqual(sortedSf.values, result);
690690
});
691691
});

‎src/danfojs-node/test/core/frame.test.ts‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1561,7 +1561,7 @@ describe("DataFrame", function () {
15611561
const df_val = [[2, 4],
15621562
[180, 360],
15631563
[180, 360]]
1564-
assert.deepEqual((df.dropNa(0) as DataFrame).values, df_val);
1564+
assert.deepEqual((df.dropNa({ axis: 0 }) as DataFrame).values, df_val);
15651565

15661566
});
15671567
it("drop NaNs along axis 1", function () {
@@ -1572,15 +1572,15 @@ describe("DataFrame", function () {
15721572
const df = new DataFrame(data, { columns: column });
15731573
const df_val = [[0, 2, 4],
15741574
[360, 180, 360]]
1575-
assert.deepEqual((df.dropNa(1) as DataFrame).values, df_val);
1575+
assert.deepEqual((df.dropNa({ axis: 1 }) as DataFrame).values, df_val);
15761576

15771577
});
15781578
it("drop NaNs along axis 1", function () {
15791579
const data = [[NaN, 1, 2, 3], [3, 4, NaN, 9], [5, 6, 7, 8]];
15801580
const column = ["A", "B", "C", "D"];
15811581
const df = new DataFrame(data, { columns: column });
15821582
const df_val = [[5, 6, 7, 8]];
1583-
assert.deepEqual((df.dropNa(1) as DataFrame).values, df_val);
1583+
assert.deepEqual((df.dropNa({ axis: 1 }) as DataFrame).values, df_val);
15841584

15851585
});
15861586
it("drop inplace at axis 0, inplace false ", function () {
@@ -1590,7 +1590,7 @@ describe("DataFrame", function () {
15901590

15911591
const df_val = [[1, 3], [4, 9], [6, 8]];
15921592

1593-
assert.deepEqual((df.dropNa(0) as DataFrame).values, df_val);
1593+
assert.deepEqual((df.dropNa({ axis: 0 }) as DataFrame).values, df_val);
15941594

15951595
});
15961596
it("drop inplace at axis 0, inplace true ", function () {
@@ -1599,7 +1599,7 @@ describe("DataFrame", function () {
15991599
const df = new DataFrame(data, { columns: column });
16001600

16011601
const df_val = [[1, 3], [4, 9], [6, 8]];
1602-
df.dropNa(0, { inplace: true });
1602+
df.dropNa({ axis: 0, inplace: true });
16031603
assert.deepEqual(df.values, df_val);
16041604

16051605
});
@@ -1610,7 +1610,7 @@ describe("DataFrame", function () {
16101610

16111611
const df_val = [[5, 6, 7, 8]];
16121612

1613-
df.dropNa(1, { inplace: true });
1613+
df.dropNa({ axis: 1, inplace: true });
16141614
assert.deepEqual(df.values, df_val);
16151615

16161616
});
@@ -1621,7 +1621,7 @@ describe("DataFrame", function () {
16211621

16221622
let df_val = [[5, 6, 7, 8]];
16231623

1624-
df.dropNa(1, { inplace: true });
1624+
df.dropNa({ axis: 1, inplace: true });
16251625
assert.deepEqual(df.values, df_val);
16261626

16271627
});
@@ -2703,13 +2703,13 @@ describe("DataFrame", function () {
27032703

27042704
it("Confirms that column names are not changed", function () {
27052705

2706-
let data = [ [ 1, 2, 3 ], [ 4, 5, 6 ], [ 20, 30, 40 ], [ 39, 89, 78 ] ];
2707-
let cols = [ "A", "B", "C" ];
2706+
let data = [[1, 2, 3], [4, 5, 6], [20, 30, 40], [39, 89, 78]];
2707+
let cols = ["A", "B", "C"];
27082708
let df = new DataFrame(data, { columns: cols });
2709-
let df_query = df.query( df["B"].ge(5));
2710-
assert.deepEqual(df_query.index, [ 1, 2, 3 ]);
2711-
assert.deepEqual(df_query.columns, [ "A", "B", "C" ]);
2712-
});
2709+
let df_query = df.query(df["B"].ge(5));
2710+
assert.deepEqual(df_query.index, [1, 2, 3]);
2711+
assert.deepEqual(df_query.columns, ["A", "B", "C"]);
2712+
});
27132713

27142714
});
27152715

‎src/danfojs-node/test/core/series.test.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -653,20 +653,20 @@ describe("Series Functions", () => {
653653
const sf = new Series([20, 30, 1, 2, 4, 57, 89, 0, 4]);
654654
const result = [0, 1, 2, 4, 4, 20, 30, 57, 89];
655655
const expectedIndex = [7, 2, 3, 8, 4, 0, 1, 5, 6];
656-
sf.sortValues(true, { inplace: true });
656+
sf.sortValues({ ascending: true, inplace: true });
657657
assert.deepEqual(sf.values, result);
658658
assert.deepEqual(sf.index, expectedIndex);
659659
});
660660
it("Sort values in a Series in Descending order", function () {
661661
const sf = new Series([20, 30, 1, 2, 4, 57, 89, 0, 4]);
662662
const result = [89, 57, 30, 20, 4, 4, 2, 1, 0];
663-
const sortedSf = sf.sortValues(false);
663+
const sortedSf = sf.sortValues({ascending: false});
664664
assert.deepEqual((sortedSf as Series).values, result);
665665
});
666666
it("confirms that sortValues in descending order happens inplace", function () {
667667
const sf = new Series([20, 30, 1, 2, 4, 57, 89, 0, 4]);
668668
const result = [89, 57, 30, 20, 4, 4, 2, 1, 0];
669-
sf.sortValues(false, { inplace: true });
669+
sf.sortValues({ ascending: false, inplace: true });
670670
assert.deepEqual(sf.values, result);
671671
});
672672
it("Confirms that series index is sorted in ascending order (not in inplace)", function () {
@@ -678,13 +678,13 @@ describe("Series Functions", () => {
678678
it("Confirms that series index is sorted in descending order (not in inplace)", function () {
679679
const sf = new Series([20, 30, 1, 2, 4, 57, 89, 0, 4]);
680680
const result = [6, 5, 1, 0, 4, 8, 3, 2, 7];
681-
const sortedSf = sf.sortValues(false) as Series
681+
const sortedSf = sf.sortValues({ ascending: false}) as Series
682682
assert.deepEqual(sortedSf.index, result);
683683
});
684684
it("Sort string values in a Series", function () {
685685
const sf = new Series(["boy", "zebra", "girl", "man"]);
686686
const result = ["boy", "girl", "man", "zebra"];
687-
const sortedSf = sf.sortValues(false) as Series
687+
const sortedSf = sf.sortValues({ ascending: false}) as Series
688688
assert.deepEqual(sortedSf.values, result);
689689
});
690690
});

0 commit comments

Comments
 (0)