samplics icon indicating copy to clipboard operation
samplics copied to clipboard

Getting Started Documentation Issue

Open kevintcaron opened this issue 2 months ago • 2 comments

Hello,

It looks like the Getting Started documentation suggests the use of the following code snippet:

`import samplics from samplics.estimation import TaylorEstimation, ReplicateEstimator

zinc_mean_str = TaylorEstimator("mean").estimate( y=nhanes2f["zinc"], samp_weight=nhanes2f["finalwgt"], stratum=nhanes2f["stratid"], psu=nhanes2f["psuid"], exclude_nan=True )

ratio_wgt_hgt = ReplicateEstimator("brr", "ratio").estimate( y=nhanes2brr["weight"], samp_weight=nhanes2brr["finalwgt"], x=nhanes2brr["height"], rep_weights=nhanes2brr.loc[:, "brr_1":"brr_32"], exclude_nan = True )`

However, the init.py file for samplics.estimation uses TaylorEstimator, not TaylorEstimation. This caused me some confusion until I reoslved the issue by editing the provided snippet. Please consider updating the getting started material.

Thanks for your work on this awesome project!

Kevin

kevintcaron avatar Apr 29 '24 20:04 kevintcaron