Skip to content

Commit

Permalink
groom readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ernestoarbitrio committed Nov 20, 2024
1 parent 72264e9 commit 3c3b551
Showing 1 changed file with 2 additions and 23 deletions.
25 changes: 2 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,30 +80,9 @@ simple as:
np.array([[1169, 547],
[1473, 1261]])

## API
## Complete API Doc

### `as_array`

Tabular, or matrix, representation of the _cube_. The detailed description can
be found
[here](http://crunch-cube.readthedocs.io/en/latest/cr.cube.html#cr-cube-crunch-cube-module).

### `margin`

Calculates margins of the _cube_. The detailed description can be found
[here](http://crunch-cube.readthedocs.io/en/latest/cr.cube.html#cr-cube-crunch-cube-module).

### `proportions`

Calculates proportions of single variable elements to the whole sample size.
The detailed description can be found
[here](http://crunch-cube.readthedocs.io/en/latest/cr.cube.html#cr-cube-crunch-cube-module).

### `percentages`

Calculates percentages of single variable elements to the whole sample size.
The detailed description can be found
[here](http://crunch-cube.readthedocs.io/en/latest/cr.cube.html#cr-cube-crunch-cube-module).
Please visit https://crunch-cube.readthedocs.io/en/latest for the API reference.

---

Expand Down

0 comments on commit 3c3b551

Please sign in to comment.