From 2e2d35243897875fe958f84282923096dcf9fac7 Mon Sep 17 00:00:00 2001 From: Ariane Ducellier Date: Tue, 29 Oct 2024 13:01:31 -0700 Subject: [PATCH] update the README --- README.md | 15 ++------------- 1 file changed, 2 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 0cf99a0..12d8ff6 100644 --- a/README.md +++ b/README.md @@ -5,17 +5,6 @@ [![codecov](https://img.shields.io/codecov/c/github/ihmeuw-msca/raking)](https://codecov.io/gh/ihmeuw-msca/raking) [![codacy](https://img.shields.io/codacy/grade/ae72a07785f5469eac234d1f6bdf555f)](https://app.codacy.com/gh/ihmeuw-msca/raking/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) -# Python Template Package +# Raking -PyPkg is a template package to guide you setup your own Python package. -It can be cloned and used as a starting point for your project. -We also want to use this documentation to help users understand key concepts -when building a Python package, include - -* Project organization -* Style guide -* Testing and documentation -* Continuous integration and deployment - -It will bring standards, consistency and best practices into your projects and -make collaborations easier. +Raking is a well known method in survey sampling to adjust the cases in a contingency table to match the known marginal totals. This package has been developed to rake 1, 2 and 3D contingency tables.