Skip to content
This repository has been archived by the owner on May 7, 2023. It is now read-only.

Commit

Permalink
Improve the doc in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
synw committed Apr 12, 2020
1 parent 5034828 commit f959232
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Expand Up @@ -14,6 +14,16 @@ From csv:
final df = await DataFrame.fromCsv("dataset/stocks.csv");
```

Optional parameters:

**`dateFormat`**: the string format of the date: [reference](https://pub.dev/documentation/intl/latest/intl/DateFormat-class.html). Ex: `MMM dd yyyy`

**`timestampCol`**: the column to be treated as a timestamp. Ex: `timestamp`

**`timestampFormat`**: the format of the timestamp: seconds, milliseconds or microseconds. Ex: `TimestampFormat.microseconds`

**`verbose`**: set to true to print some info

From records:

```dart
Expand Down Expand Up @@ -41,7 +51,10 @@ From records:
Add data:

```dart
// add a row
df.addRow(<String,dynamic>{"col1": 1, "col2": 2.0});
// add a line of records
df.addRecord(<dynamic>[1, 2.0]);
```

Remove data:
Expand Down

0 comments on commit f959232

Please sign in to comment.