Metadata-Version: 2.4
Name: scitex-pd
Version: 0.1.3
Summary: Pandas helpers (force_df, melt_cols, find_pval, mv, slice, sort, round, …) — standalone module from the SciTeX ecosystem
Author-email: Yusuke Watanabe <ywatanabe@scitex.ai>
License-Expression: AGPL-3.0-only
Project-URL: Homepage, https://github.com/ywatanabe1989/scitex-pd
Project-URL: Repository, https://github.com/ywatanabe1989/scitex-pd
Project-URL: Documentation, https://scitex-pd.readthedocs.io
Keywords: scitex,pandas,dataframe,data-frame
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: scitex-types>=0.1.0
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: scitex-dev>=0.11.7; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=7.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=2.0; extra == "docs"
Requires-Dist: myst-parser>=2.0; extra == "docs"
Requires-Dist: sphinx-copybutton>=0.5; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints>=1.25; extra == "docs"
Provides-Extra: all
Requires-Dist: scitex-pd[dev,docs]; extra == "all"
Dynamic: license-file

# scitex-pd

<p align="center">
  <a href="https://scitex.ai">
    <img src="docs/scitex-logo-blue-cropped.png" alt="SciTeX" width="400">
  </a>
</p>

<p align="center"><b>Pandas helpers — coerce, reshape, find p-values, merge/melt columns, sort/slice/round.</b></p>

<p align="center">
  <a href="https://scitex-pd.readthedocs.io/">Full Documentation</a> · <code>uv pip install scitex-pd[all]</code>
</p>

<!-- scitex-badges:start -->
<p align="center">
  <a href="https://pypi.org/project/scitex-pd/"><img src="https://img.shields.io/pypi/v/scitex-pd.svg" alt="PyPI"></a>
  <a href="https://pypi.org/project/scitex-pd/"><img src="https://img.shields.io/pypi/pyversions/scitex-pd.svg" alt="Python"></a>
  <a href="https://github.com/ywatanabe1989/scitex-pd/actions/workflows/test.yml"><img src="https://github.com/ywatanabe1989/scitex-pd/actions/workflows/test.yml/badge.svg" alt="Tests"></a>
  <a href="https://github.com/ywatanabe1989/scitex-pd/actions/workflows/install-test.yml"><img src="https://github.com/ywatanabe1989/scitex-pd/actions/workflows/install-test.yml/badge.svg" alt="Install Test"></a>
  <a href="https://codecov.io/gh/ywatanabe1989/scitex-pd"><img src="https://codecov.io/gh/ywatanabe1989/scitex-pd/graph/badge.svg" alt="Coverage"></a>
  <a href="https://scitex-pd.readthedocs.io/en/latest/"><img src="https://readthedocs.org/projects/scitex-pd/badge/?version=latest" alt="Docs"></a>
  <a href="https://www.gnu.org/licenses/agpl-3.0"><img src="https://img.shields.io/badge/license-AGPL_v3-blue.svg" alt="License: AGPL v3"></a>
</p>
<!-- scitex-badges:end -->

---

## Problem and Solution

| # | Problem | Solution |
|---|---------|----------|
| 1 | **Pandas reshape boilerplate** — coercing dicts/Series/lists into DataFrames, pivoting long↔wide, and locating p-value columns is repeated noise across analysis scripts | **`force_df`, `from_xyz`/`to_xy`, `find_pval`** — small composable helpers with sensible defaults |
| 2 | **Column ops drift** — every project re-implements rename / reorder / round / merge for stats tables | **`merge_columns`, `mv`, `round`, `replace`, `sort`, `slice`** — uniform DataFrame-in / DataFrame-out helpers |

## Installation

```bash
pip install scitex-pd
```

## Architecture

```
src/scitex_pd/
├── __init__.py              # public API surface
├── _force_df.py             # dict / Series / list → DataFrame
├── _find_pval.py            # locate p-value columns
├── _find_indi.py            # boolean-mask helpers
├── _get_unique.py           # unique-values per column
├── _merge_columns.py        # combine columns into one
├── _melt_cols.py            # long ↔ wide reshapes
├── _mv.py                   # reorder columns
├── _replace.py              # value remapping
├── _round.py                # rounding with NaN safety
├── _slice.py                # row / column subsetting
├── _sort.py                 # multi-key sort wrappers
├── _ignore_SettingWithCopyWarning.py
└── _convert/                # long ↔ wide pivots (from_xyz / to_xy / to_xyz)
```

`scitex-pd` is a thin layer on top of `pandas` + `numpy`; the only
non-stdlib dep beyond those is `scitex-types` (for `is_listed_X`).

## 1 Interfaces

<details open>
<summary><strong>Python API</strong></summary>

<br>

```python
import scitex_pd as pd_

# Coerce / convert
pd_.force_df(data)
pd_.from_xyz(df, x, y, z)
pd_.to_xy(df)
pd_.to_xyz(df)
pd_.to_numeric(df)

# Find / inspect
pd_.find_pval(df)
pd_.find_indi(df, mask)
pd_.get_unique(df, "col")

# Reshape / restructure
pd_.merge_columns(df, [...], "out")
pd_.melt_cols(df, [...])
pd_.mv(df, col, position=-1)

# Transform
pd_.replace(df, mapping)
pd_.round(df, ndigits=2)
pd_.slice(df, ...)
pd_.sort(df, ...)

# Warnings
pd_.ignore_setting_with_copy_warning()
```

</details>

## Demo

```mermaid
flowchart LR
    raw["dict / Series / list / scalar"] --> force["force_df"]
    force --> df[(DataFrame)]
    df --> reshape["from_xyz / to_xy / melt_cols"]
    df --> inspect["find_pval / get_unique"]
    df --> transform["round / replace / sort / slice / mv"]
    reshape --> out[(reshaped DataFrame)]
    inspect --> out2[("p-value columns / uniques")]
    transform --> out3[(transformed DataFrame)]
```

## Quick Start

```python
import scitex_pd as pd_

pd_.force_df(data)              # Coerce dict / Series / list / scalar → DataFrame
pd_.from_xyz(df, x, y, z)       # Long → wide pivot
pd_.to_xy(df)                   # Wide → long
pd_.find_pval(df)               # Locate p-value columns
```

## Status

Standalone fork of `scitex.pd`. Deps: numpy, pandas, scitex-types (for `is_listed_X`).
The umbrella package's `scitex.pd` import path is preserved via a
`sys.modules`-alias bridge.

## Part of SciTeX

`scitex-pd` is part of [**SciTeX**](https://scitex.ai). Install via
the umbrella with `pip install scitex[pd]` to use as
`scitex.pd` (Python) or `scitex pd ...` (CLI).

>Four Freedoms for Research
>
>0. The freedom to **run** your research anywhere — your machine, your terms.
>1. The freedom to **study** how every step works — from raw data to final manuscript.
>2. The freedom to **redistribute** your workflows, not just your papers.
>3. The freedom to **modify** any module and share improvements with the community.
>
>AGPL-3.0 — because we believe research infrastructure deserves the same freedoms as the software it runs on.

## License

AGPL-3.0-only (see [LICENSE](./LICENSE)).

---

<p align="center">
  <a href="https://scitex.ai" target="_blank"><img src="docs/scitex-icon-navy-inverted.png" alt="SciTeX" width="40"/></a>
</p>
