benf 2.1.1

Benford's Law analysis CLI - convenience wrapper for lawkit benf
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

# benf - Benford Law Analysis

A convenience command for Benford Law analysis, part of the [**lawkit**](https://github.com/kako-jun/lawkit) statistical analysis toolkit.

## Quick Start

```bash
# Install both benf and lawkit
cargo install lawkit benf

# Basic analysis
echo "123 456 789 101 234" | benf

# File analysis
benf data.csv --format json

# Advanced options (requires lawkit)
lawkit benf data.xlsx --verbose --filter ">=1000"
```

## What is Benford Law?

Benford Law states that in many naturally occurring datasets, the first digit 1 appears about 30% of the time, 2 appears about 18% of the time, and so on. Deviations from this pattern often indicate:

- **Financial fraud** in accounting data
- **Data manipulation** in scientific studies  
- **Errors** in data collection or processing

## Features

- **International number formats**: Japanese (１２３), Chinese (一二三), Arabic (١٢٣)
- **Multiple file formats**: CSV, JSON, YAML, Excel, PDF, Word documents
- **Statistical rigor**: Chi-square test, p-values, confidence intervals
- **Risk assessment**: Automatic anomaly detection with severity levels

## Full Statistical Toolkit

This `benf` command is a convenience wrapper for `lawkit benf`. For complete statistical analysis capabilities, use **lawkit**:

### Available Statistical Laws
- **Benford Law**: `lawkit benf` - Fraud detection and anomaly analysis
- **Pareto Principle**: `lawkit pareto` - 80/20 rule and concentration measurement  
- **Zipf Law**: `lawkit zipf` - Power-law distribution analysis
- **Normal Distribution**: `lawkit normal` - Normality testing and outlier detection
- **Poisson Distribution**: `lawkit poisson` - Rare event analysis

### Advanced Features
- **Multi-law comparison**: `lawkit compare data.csv`
- **Data generation**: `lawkit generate benf --samples 1000`
- **Performance optimization**: `--optimize` flag for large datasets
- **Comprehensive reporting**: Multiple output formats with detailed statistics

## Installation

```bash
# Install the full toolkit (recommended)
cargo install lawkit

# Or install just this convenience command
cargo install benf

# Or download binaries
# https://github.com/kako-jun/lawkit/releases
```

## Examples

```bash
# Basic fraud detection
benf expenses.csv

# Financial audit with detailed output
benf quarterly-report.xlsx --verbose --format json

# Process large datasets efficiently  
lawkit benf big-data.csv --optimize --min-count 1000

# Compare multiple statistical laws
lawkit compare financial-data.csv

# Generate test data for validation
lawkit generate benf --samples 10000 | lawkit benf --format json
```

## Documentation

- **Complete Documentation**: https://github.com/kako-jun/lawkit/tree/main/docs
- **API Reference**: https://docs.rs/lawkit-core
- **Usage Examples**: https://github.com/kako-jun/lawkit/blob/main/docs/user-guide/examples.md

## License

MIT License - see [LICENSE](https://github.com/kako-jun/lawkit/blob/main/LICENSE) for details.

---

**💡 Tip**: For professional statistical analysis with multiple laws and advanced features, use the full `lawkit` command instead of individual law commands.