Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leafyeexyz/psychsheet
Read and write data files in Browsers and Node/Deno/Bun. Support sav, dta, parquet, xlsx, json, csv, numbers, etc.
https://github.com/leafyeexyz/psychsheet
data-science deno file-format javascript jsr psychology statistics typescript
Last synced: about 13 hours ago
JSON representation
Read and write data files in Browsers and Node/Deno/Bun. Support sav, dta, parquet, xlsx, json, csv, numbers, etc.
- Host: GitHub
- URL: https://github.com/leafyeexyz/psychsheet
- Owner: LeafYeeXYZ
- License: gpl-3.0
- Created: 2024-11-08T04:45:05.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-07T04:36:39.000Z (about 1 month ago)
- Last Synced: 2024-12-07T05:19:54.490Z (about 1 month ago)
- Topics: data-science, deno, file-format, javascript, jsr, psychology, statistics, typescript
- Language: JavaScript
- Homepage: https://jsr.io/@psych/sheet
- Size: 342 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Introduction
[](https://jsr.io/@psych/sheet) [](https://jsr.io/@psych) [](https://jsr.io/@psych/sheet/score)
**PsychSheet** is a TypeScript library for parsing any data files into a universal format. It can be used to parse `.csv`, `.xlsx`, `.sav`, `.parquet`, `.dta`, `.numbers`, etc., into a json object array. And export the data to `.csv`, `.xlsx`, `.numbers`, etc.
- PsychSheet can be used in all modern JavaScript/TypeScript environments, including browsers, Node.js, Deno, and Bun.
- PsychSheet mainly based on [SheetJS](https://sheetjs.com/), but added more file formats for psychological and educational research.
- For use cases, please refer to my another project [PsychPen](https://github.com/LeafYeeXYZ/PsychPen).
**For full documentation and supported file formats, see .**
- [Introduction](#introduction)
- [Qiuck Start](#qiuck-start)
- [Installation](#installation)
- [Use in Browser](#use-in-browser)
- [Use in Deno/Node/Bun](#use-in-denonodebun)
- [Development](#development)
# Qiuck Start
## Installation
```bash
npx jsr add @psych/sheet # if using npm
bunx jsr add @psych/sheet # if using bun
deno add jsr:@psych/sheet # if using deno
pnpm dlx jsr add @psych/sheet # if using pnpm
yarn dlx jsr add @psych/sheet # if using yarn
```
## Use in Browser
```typescript
import { importSheet, downloadSheet } from '@psych/sheet'
const file = document.getElementById('file')
file.addEventListener('change', async () => {
const data = await importSheet(await file.files[0].arrayBuffer(), 'xlsx')
console.log(data[0], data.length)
downloadSheet(data, 'csv', 'example')
})
```
## Use in Deno/Node/Bun
```typescript
import { importSheet, exportSheet } from '@psych/sheet'
import { readFile, writeFile } from 'node:fs/promises'
import { resolve } from 'node:path'
const filepath = resolve(import.meta.dirname!, 'example.xlsx')
const file = await readFile(filepath)
const data = await importSheet(file, 'xlsx')
console.log(data[0], data.length)
await writeFile(resolve(import.meta.dirname!, 'example.csv'), exportSheet(data, 'csv'))
```
**For full documentation and supported file formats, see .**
# Development
- `parquet` file format is supported by .
- `sav` file format is supported by . But it doesn't run in the Browser originally `can not found 'global' error`, so I have to modify the source code to make it work. You can find the source code in the `/lib/sav` folder.
- `dta`、`xlsx`、`numbers` file formats are supported by . But `JSR` doesn't support importing modules from third-party URLs, so I have to download the source code and import them locally. You can find the source code in the `/lib/xlsx` folder.
If you haven't installed `deno` yet, please install it referring to the . Then, clone this repository.
```bash
git clone https://github.com/LeafYeeXYZ/PsychSheet.git
```
Now you can write `TypeScript` code in `/lib/**/*.ts` and export functions in `/lib/index.ts`. Note that you should not import base functions from `/lib/index.ts` to avoid circular dependencies.
After writing the code, remember to add test cases in `/tests/*.test.ts`. You can run the test cases using the following command.
```bash
deno test -A
```
This project publishes to , so you don't need to compile the code to JavaScript. And you also don't need to publish the package manually. Just modify `deno.json` and push the code to the repository. The `GitHub Action` will do the rest for you.