2023-11-13 11:03:35 +00:00
|
|
|
# DTA Data File Codec
|
|
|
|
|
|
|
|
Codec for reading Stata .DTA files and generating CSF workbook objects
|
|
|
|
compatible with the [SheetJS](https://sheetjs.com) library constellation.
|
|
|
|
|
|
|
|
DTA datasets can support millions of observations and over 32767 variables.
|
|
|
|
The codec will truncate data to 1048576 observations and 16384 variables.
|
|
|
|
|
2023-12-05 08:19:42 +00:00
|
|
|
<https://docs.sheetjs.com/docs/constellation/dta> includes a live demo.
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
Using NodeJS package manager:
|
|
|
|
|
|
|
|
```bash
|
2024-03-22 04:39:09 +00:00
|
|
|
npm install --save https://cdn.sheetjs.com/dta-0.0.2/dta-0.0.2.tgz
|
2023-12-05 08:19:42 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
The standalone script is also hosted on the SheetJS CDN:
|
|
|
|
|
|
|
|
```html
|
2024-03-22 04:39:09 +00:00
|
|
|
<script src="https://cdn.sheetjs.com/dta-0.0.2/package/dist/dta.min.js"></script>
|
2023-12-05 08:19:42 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
The `parse` method accepts a `Uint8Array` representing the file data. It returns
|
|
|
|
a ["Common Spreadsheet Format"](https://docs.sheetjs.com/docs/csf/) workbook
|
|
|
|
object.
|
|
|
|
|
|
|
|
The `set_utils` method accepts a `utils` object from SheetJS CE or a SheetJS
|
|
|
|
Pro build. `parse` will use methods from the `utils` object.
|
|
|
|
|
|
|
|
### NodeJS
|
|
|
|
|
|
|
|
```js
|
|
|
|
const XLSX = require("xlsx"), DTA = require("dta");
|
|
|
|
DTA.set_utils(XLSX.utils);
|
|
|
|
|
|
|
|
const wb = DTA.parse(fs.readFileSync("auto.dta"));
|
|
|
|
```
|
|
|
|
|
|
|
|
### Browser
|
|
|
|
|
|
|
|
`dist/dta.min.js` is a standalone build designed to be added with `<script>`.
|
|
|
|
|
|
|
|
```html
|
|
|
|
<script lang="javascript" src="https://cdn.sheetjs.com/xlsx-latest/package/dist/xlsx.full.min.js"></script>
|
|
|
|
<script src="dist/dta.min.js"></script>
|
|
|
|
<div id="out"></div>
|
|
|
|
<script>
|
|
|
|
DTA.set_utils(XLSX.utils);
|
|
|
|
(async() => {
|
|
|
|
/* fetch file */
|
2024-01-10 09:54:10 +00:00
|
|
|
const data = await (await fetch("test.dta")).arrayBuffer();
|
2023-12-05 08:19:42 +00:00
|
|
|
/* parse */
|
|
|
|
const wb = DTA.parse(new Uint8Array(data));
|
|
|
|
/* wb is a SheetJS workbook object */
|
|
|
|
const html = XLSX.utils.sheet_to_html(wb.Sheets[wb.SheetNames[0]]);
|
|
|
|
out.innerHTML = html;
|
|
|
|
})();
|
|
|
|
</script>
|
2024-03-22 04:39:09 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
`dist/dta.mjs` is a ECMAScript Module build designed to be used with bundlers:
|
|
|
|
|
|
|
|
```js
|
|
|
|
import * as DTA from 'dta';
|
|
|
|
```
|