Skip to content

Latest commit

 

History

History
117 lines (87 loc) · 5.48 KB

dataframe.to_csv.md

File metadata and controls

117 lines (87 loc) · 5.48 KB
Raw
description
Convert DataFrame to a comma-separated values (CSV)

DataFrame.toCSV

{% hint style="danger" %} Deprecated in v1.1.0: Use the dfd.toCSV function directly instead {% endhint %}

DataFrame.toCSV(options)
Parameters Type Description Default
options object, optional

Configuration object:

filePath: Local file path to write the CSV file to. If not specified, the CSV will be returned as a string. Only needed in Nodejs version


fileName: The name of the file to download as. Only needed in browser environment.


download: Boolean indicating whether to automatically download the CSV file in the browser. Only needed in the browser environment.

header: Boolean indicating whether to include a header row in the CSV file.

sep: Character to be used as a separator in the CSV file.

{
sep: ","
}

The toCSV function can be used to write out a DataFrame or Series to CSV file. The output is configurable and will depend on the environment. In the following examples, we show you how to write/download a CSV file from Node and Browser environments.

Convert DataFrame to CSV string and return value

{% tabs %} {% tab title="Node.js" %}

const dfd = require("danfojs-node")

let data = {
  Abs: [20.2, 30, 47.3],
  Count: [34, 4, 5],
  "country code": ["NG", "FR", "GH"],
};

let df = new dfd.DataFrame(data);

const csv = df.toCSV();
console.log(csv);

//output
Abs,Count,country code
20.2,34,NG
30,4,FR
47.3,5,GH

{% endtab %}

{% tab title="Browser" %}

<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <script src="https://cdn.jsdelivr.net/npm/[email protected]/lib/bundle.min.js"></script>
    <title>Document</title>
</head>

<body>

    <script>

       let data = {
          Abs: [20.2, 30, 47.3],
          Count: [34, 4, 5],
          "country code": ["NG", "FR", "GH"],
        };
        
        let df = new dfd.DataFrame(data);
        
        const csv = df.to_csv({ download: false });
        console.log(csv);
    </script>
</body>

</html>

{% endtab %} {% endtabs %}

Convert DataFrame to CSV and write to local file path

Writing a CSV file to a local file path is only supported in the Nodejs environment

{% tabs %} {% tab title="Node.js" %}

const dfd = require("danfojs-node")

let data = {
    Abs: [20.2, 30, 47.3],
    Count: [34, 4, 5],
    "country code": ["NG", "FR", "GH"],
};

let df = new dfd.DataFrame(data);
 df.toCSV({ filePath: "testOut.csv"});

{% endtab %} {% endtabs %}

Convert DataFrame to CSV and download file in browser

You can automatically convert and download a CSV file in a browser environment, by specifying a fileName and setting download to true.

let data = {
    Abs: [20.2, 30, 47.3],
    Count: [34, 4, 5],
    "country code": ["NG", "FR", "GH"],
};

let df = new dfd.DataFrame(data);

df.toCSV({ fileName: "testOut.csv", download: true});