codonPython/codonPython.html at gh-pages · NHSDigital/codonPython

History

889 lines (761 loc) · 63.6 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

<!DOCTYPE html>

<html class="no-js" lang="en" >

<head>

<title>codonPython package — codon 0.0.21 documentation</title>

</head>

<a href="index.html" class="icon icon-home"> codon

</a>

</form>

</div>

Contents:

<li class="toctree-l1 current"><a class="reference internal" href="modules.html">codonPython</a><ul class="current">

<li class="toctree-l2 current"><a class="current reference internal" href="#">codonPython package</a><ul>

<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.age_bands">codonPython.age_bands module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.check_consistent_measures">codonPython.check_consistent_measures module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.check_consistent_submissions">codonPython.check_consistent_submissions module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.check_nat_val">codonPython.check_nat_val module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.check_null">codonPython.check_null module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.dateValidator">codonPython.dateValidator module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.file_utils">codonPython.file_utils module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.nhsd_colours">codonPython.nhsd_colours module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.nhsNumber">codonPython.nhsNumber module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.suppression">codonPython.suppression module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.tableFromSql">codonPython.tableFromSql module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.tolerance">codonPython.tolerance module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython">Module contents</a></li>

</ul>

</li>

</ul>

</li>

</ul>

</div>

</nav>

<a href="index.html">codon</a>

</nav>

<li><a href="modules.html">codonPython</a> »</li>

<li>codonPython package</li>

<a href="_sources/codonPython.rst.txt" rel="nofollow"> View page source</a>

</li>

</ul>

<hr/>

</div>

<h1>codonPython package<a class="headerlink" href="#codonpython-package" title="Permalink to this headline">¶</a></h1>

<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>

</div>

<h2>codonPython.age_bands module<a class="headerlink" href="#module-codonPython.age_bands" title="Permalink to this headline">¶</a></h2>

<code class="sig-prename descclassname">codonPython.age_bands.</code><code class="sig-name descname">age_band_10_years</code>(age: int) → str<a class="headerlink" href="#codonPython.age_bands.age_band_10_years" title="Permalink to this definition">¶</a></dt>

<dd>Place age into appropriate 10 year band

This function takes the age supplied as an argument and returns a string

representing the relevant 10 year banding.

<dt class="field-odd">Parameters</dt>

<dd class="field-odd">age (int) – Age of the person

</dd>

<dt class="field-even">Returns</dt>

<dd class="field-even">out – The 10 year age band

</dd>

<dt class="field-odd">Return type</dt>

<dd class="field-odd">str

</dd>

</dl>

Examples

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> age_band_10_years(3)

'0-9'

>>> age_band_10_years(None)

'Age not known'

>>> age_band_10_years(95)

'90 and over'

</pre></div>

</div>

</dd></dl>

<code class="sig-prename descclassname">codonPython.age_bands.</code><code class="sig-name descname">age_band_5_years</code>(age: int) → str<a class="headerlink" href="#codonPython.age_bands.age_band_5_years" title="Permalink to this definition">¶</a></dt>

<dd>Place age into appropriate 5 year band

This function takes the age supplied as an argument and returns a string

representing the relevant 5 year banding.

<dt class="field-odd">Parameters</dt>

<dd class="field-odd">age (int) – Age of the person

</dd>

<dt class="field-even">Returns</dt>

<dd class="field-even">out – The 5 year age band

</dd>

<dt class="field-odd">Return type</dt>

<dd class="field-odd">str

</dd>

</dl>

Examples

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> age_band_5_years(3)

'0-4'

>>> age_band_5_years(None)

'Age not known'

>>> age_band_5_years(95)

'90 and over'

</pre></div>

</div>

</dd></dl>

</div>

<h2>codonPython.check_consistent_measures module<a class="headerlink" href="#module-codonPython.check_consistent_measures" title="Permalink to this headline">¶</a></h2>

<code class="sig-prename descclassname">codonPython.check_consistent_measures.</code><code class="sig-name descname">check_consistent_measures</code>(data, geography_col: str = 'Org_Level', measure_col: str = 'Measure', measures_set: set = {}) → bool<a class="headerlink" href="#codonPython.check_consistent_measures.check_consistent_measures" title="Permalink to this definition">¶</a></dt>

<dd>Check every measure is in every geography level.

<dt class="field-odd">Parameters</dt>

<li>data (pd.DataFrame) – DataFrame of data to check.</li>

<li>geography_col (str, default = "Org_Level") – Column name for the geography level.</li>

<li>measure_col (str, default = "Measure") – Column name for measure</li>

<li>measures_set (set, default = set()) – Set of measures that should be in every geography level. If empty, the existing

global set is presumed to be correct.</li>

</ul>

</dd>

<dt class="field-even">Returns</dt>

<dd class="field-even">Whether the checks have been passed.

</dd>

<dt class="field-odd">Return type</dt>

<dd class="field-odd">bool

</dd>

</dl>

Examples

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> check_consistent_measures(

... pd.DataFrame({

... "Geog" : ["National" ,"National", "Region", "Region", "Local", "Local",],

... "measure" : ["m1", "m2", "m1", "m2", "m1", "m2",],

... "Value_Unsuppressed" : [4, 2, 2, 1, 2, 1,],

... }),

... geography_col = "Geog",

... measure_col = "measure",

... measures_set = set({"m1", "m2"}),

... )

True

>>> check_consistent_measures(

... pd.DataFrame({

... "Org_Level" : ["National" ,"National", "Region", "Region", "Local", "Local",],

... "Measure" : ["m1", "m3", "m1", "m2", "m1", "m2",],

... })

... )

False

</pre></div>

</div>

</dd></dl>

</div>

<h2>codonPython.check_consistent_submissions module<a class="headerlink" href="#module-codonPython.check_consistent_submissions" title="Permalink to this headline">¶</a></h2>

<code class="sig-prename descclassname">codonPython.check_consistent_submissions.</code><code class="sig-name descname">check_consistent_submissions</code>(data, national_geog_level: str = 'National', geography_col: str = 'Org_Level', submissions_col: str = 'Value_Unsuppressed', measure_col: str = 'Measure') → bool<a class="headerlink" href="#codonPython.check_consistent_submissions.check_consistent_submissions" title="Permalink to this definition">¶</a></dt>

<dd>Check total submissions for each measure are the same across all geography levels

except national.

<dt class="field-odd">Parameters</dt>

<li>data (pd.DataFrame) – DataFrame of data to check.</li>

<li>national_geog_level (str, default = "National") – Geography level code for national values.</li>

<li>geography_col (str, default = "Org_Level") – Column name for the geography level.</li>

<li>submissions_col (str, default = "Value_Unsuppressed") – Column name for the submissions count.</li>

<li>measure_col (str, default = "Measure") – Column name for measure.</li>

</ul>

</dd>

<dt class="field-even">Returns</dt>

<dd class="field-even">Whether the checks have been passed.

</dd>

<dt class="field-odd">Return type</dt>

<dd class="field-odd">bool

</dd>

</dl>

Examples

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> check_consistent_submissions(

... pd.DataFrame({

... "Geog" : ["N" ,"N", "Region", "Region", "Local", "Local",],

... "submissions" : [4, 2, 2, 1, 2, 1,],

... }),

... national_geog_level = "N",

... geography_col = "Geog",

... submissions_col = "submissions",

... measure_col = "measure",

... )

True

>>> check_consistent_submissions(

... pd.DataFrame({

... "Measure" : ["m1", "m2", "m1", "m2", "m1", "m2",],

... "Value_Unsuppressed" : [4, 2, 3, 1, 2, 1,],

... })

... )

False

</pre></div>

</div>

</dd></dl>

</div>

<h2>codonPython.check_nat_val module<a class="headerlink" href="#module-codonPython.check_nat_val" title="Permalink to this headline">¶</a></h2>

<code class="sig-prename descclassname">codonPython.check_nat_val.</code><code class="sig-name descname">check_nat_val</code>(df: pandas.core.frame.DataFrame, breakdown_col: str = 'Breakdown', measure_col: str = 'Measure', value_col: str = 'Value_Unsuppressed', nat_val: str = 'National') → bool<a class="headerlink" href="#codonPython.check_nat_val.check_nat_val" title="Permalink to this definition">¶</a></dt>

<dd>Check national value less than or equal to sum of breakdowns.

This function checks that the national value is less than or equal to the

sum of each organisation level breakdown.

This function does not apply to values which are averages.

This function does not apply to values which are percentages calculated

from the numerator and denominator.

<dt class="field-odd">Parameters</dt>

<li>df (pandas.DataFrame) – DataFrame of data to check.</li>

<li>breakdown_col (str, default = "Breakdown") – Column name for the breakdown level.</li>

<li>measure_col (str, default = "Measure") – Column name for measures</li>

<li>value_col (str, default = "Value_Unsuppressed") – Column name for values</li>

<li>nat_val (str, default = "National") – Value in breakdown column denoting national values</li>

</ul>

</dd>

<dt class="field-even">Returns</dt>

<dd class="field-even">Whether the checks have been passed.

</dd>

<dt class="field-odd">Return type</dt>

<dd class="field-odd">bool

</dd>

</dl>

Examples

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> check_nat_val(

... df = pd.DataFrame({

... "Breakdown" : ['National', 'CCG', 'CCG', 'Provider', 'Provider',

... 'National' ,'CCG', 'CCG', 'Provider', 'Provider','National' ,'CCG', 'CCG',

... 'Provider', 'Provider',],

... "Measure" : ['m1', 'm1', 'm1', 'm1', 'm1', 'm2', 'm2', 'm2', 'm2',

... 'm2', 'm3', 'm3', 'm3', 'm3', 'm3',],

... "Value_Unsuppressed" : [9, 4, 5, 3, 6, 11, 2, 9, 7, 4, 9, 5, 4, 6,

... 3],

... }),

... breakdown_col = "Breakdown",

... measure_col = "Measure",

... value_col = "Value_Unsuppressed",

... nat_val = "National",

... )

True

>>> check_nat_val(

... df = pd.DataFrame({

... 'Provider', 'Provider',],

... "Value_Unsuppressed" : [18, 4, 5, 3, 6, 11, 2, 9, 7, 4, 9, 5, 4, 6,

... 3],

... }),

... breakdown_col = "Breakdown",

... measure_col = "Measure",

... value_col = "Value_Unsuppressed",

... nat_val = "National",

... )

False

</pre></div>

</div>

</dd></dl>

</div>

<h2>codonPython.check_null module<a class="headerlink" href="#module-codonPython.check_null" title="Permalink to this headline">¶</a></h2>

<code class="sig-prename descclassname">codonPython.check_null.</code><code class="sig-name descname">check_null</code>(dataframe: pandas.core.frame.DataFrame, columns_to_be_checked: list) → int<a class="headerlink" href="#codonPython.check_null.check_null" title="Permalink to this definition">¶</a></dt>

<dd>Checks a pandas dataframe for null values

This function takes a pandas dataframe supplied as an argument and returns a integer value

representing any null values found within the columns to check.

<dt class="field-odd">Parameters</dt>

<li>data (pandas.DataFrame) – Dataframe to read</li>

<li>columns_to_be_checked (list) – Given dataframe columns to be checked for null values</li>

</ul>

</dd>

<dt class="field-even">Returns</dt>

<dd class="field-even">out – The number of null values found in the given columns

</dd>

<dt class="field-odd">Return type</dt>

<dd class="field-odd">int

</dd>

</dl>

Examples

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> check_null(dataframe = pd.DataFrame({'col1': [1,2], 'col2': [3,4]}),columns_to_be_checked = ['col1', 'col2'])

0

>>> check_null(dataframe = pd.DataFrame({'col1': [1,numpy.nan], 'col2': [3,4]}),columns_to_be_checked = ['col1'])

1

</pre></div>

</div>

</dd></dl>

</div>

<h2>codonPython.dateValidator module<a class="headerlink" href="#module-codonPython.dateValidator" title="Permalink to this headline">¶</a></h2>

<code class="sig-prename descclassname">codonPython.dateValidator.</code><code class="sig-name descname">validDate</code>(date_string: str) → bool<a class="headerlink" href="#codonPython.dateValidator.validDate" title="Permalink to this definition">¶</a></dt>

<dd>Validates stringtype dates of type <cite>dd/mm/yyyy</cite>, <cite>dd-mm-yyyy</cite> or <cite>dd.mm.yyyy</cite> from

years 1900-9999. Leap year support included.

<dt class="field-odd">Parameters</dt>

<dd class="field-odd">date_string (str) – Date to be validated

</dd>

<dt class="field-even">Returns</dt>

<dd class="field-even">Whether the date is valid or not

</dd>

<dt class="field-odd">Return type</dt>

<dd class="field-odd">boolean

</dd>

</dl>

Examples

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> validDate("11/02/1996")

True

>>> validDate("29/02/2016")

True

>>> validDate("43/01/1996")

False

</pre></div>

</div>

</dd></dl>

</div>

<h2>codonPython.file_utils module<a class="headerlink" href="#module-codonPython.file_utils" title="Permalink to this headline">¶</a></h2>

<code class="sig-prename descclassname">codonPython.file_utils.</code><code class="sig-name descname">compare</code>(x, y, names=['x', 'y'], dups=False, same=False, comment=False)<a class="headerlink" href="#codonPython.file_utils.compare" title="Permalink to this definition">¶</a></dt>

<dd>This function returns a dictionary with:

<li>Same values between data frames x and y</li>

<li>Values in x, not in y</li>

<li>Values in y, not in x</li>

</ol>

(optional):

(4) Duplicates of x

(5) Duplicates of y

(6) Boolean of whether x and y are the same

</div></blockquote>

<dt class="field-odd">Parameters</dt>

<li>x (pandas.DataFrame) – DataFrame #1</li>

<li>y (pandas.DataFrame) – DataFrame #2</li>

<li>names (list) – a list of user preferred file names

e.g. [‘File1’, ‘File2’]

default = [‘x’,’y’]</li>

<li>dups (bool) – True to include duplicates check for each file

default = False</li>

<li>same (bool) – True to activate. Outputs True if DataFrames are the same

default = False</li>

<li>comment (bool) – True to activate. Prints out statistics of the compariosn results

e.g. number of same valeus, number of duplicates, number of outliers and whether the DataFrames are the same

default = False</li>

</ul>

</dd>

<dt class="field-even">Returns</dt>

<dd class="field-even">out

</dd>

<dt class="field-odd">Return type</dt>

<dd class="field-odd">dict

</dd>

</dl>

Examples

‘>>> c = compare(df1, df2, names = [‘df1’,’df2’], dups = True, same = True, comment =True)’

There are 133891 same values

There are 16531 outliers in df1

There are 20937 outliers in df2

There are 48704 duplicates in df1

There are 0 duplicates in df2

The DataFrames are not the same

‘>>> c = compare(df2, df2, names = [‘df2’,’df2’], dups = True, same = True, comment =True)’

There are 154444 same values

There are 0 outliers in df2

There are 0 duplicates in df2

The DataFrames are the same

</dd></dl>

<code class="sig-prename descclassname">codonPython.file_utils.</code><code class="sig-name descname">file_search</code>(path='.', doctype='csv', like=[''], strict=False)<a class="headerlink" href="#codonPython.file_utils.file_search" title="Permalink to this definition">¶</a></dt>

<dd>This function creates a list of all files of a certain type, satisfying the criteria outlined

in like = […] parameter. The function only searches for files in the specified folder

of the current working directory that is set by the user.

<dt class="field-odd">Parameters</dt>

<li>path (string) – Path to a folder in the current working directory

default = ‘.’, i.e. current working directory folder</li>

<li>doctype (string) – Document format to search for

e.g. ‘csv’ or ‘xlsx’

default = ‘csv’</li>

<li>like (list) – A list of words to filter the file search on

default = [‘’], i.e. no filter</li>

<li>strict (bool) – Set True to search for filenames containing all words from ‘like’ list (

default = False</li>

</ul>

</dd>

<dt class="field-even">Returns</dt>

</dd>

<dt class="field-odd">Return type</dt>

<dd class="field-odd">list

</dd>

</dl>

Examples

['README.md', 'CONTRIBUTING.md']

</pre></div>

</div>

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> file_search(doctype = 'md', like = ['READ'])

['README.md']

</pre></div>

</div>

</dd></dl>

<code class="sig-prename descclassname">codonPython.file_utils.</code><code class="sig-name descname">import_files</code>(path='.', doctype='csv', sheet='Sheet1', subdir=False, like=[''], strict=False)<a class="headerlink" href="#codonPython.file_utils.import_files" title="Permalink to this definition">¶</a></dt>

<dd>This function imports all documents of a given format to a dictionary

and returns this dictionary, keeping original file names.

<dt class="field-odd">Parameters</dt>

<li>path (string) – Path to a folder in the current working directory

default = ‘.’, i.e. current working directory folder</li>

<li>doctype (string) – Document format to search for

e.g. ‘csv’ or ‘xlsx’

default = ‘csv’</li>

<li>sheet (string) – Sheet name of the xlsx file

default = ‘Sheet1’</li>

<li>subdir (bool) – True to allow download all files, including the subdirectories

default = False</li>

<li>like (list) – A list of words to filter the file search on

default = [‘’], i.e. no filter</li>

<li>strict (bool) – Set True to search for filenames containing all words from ‘like’ list

default = False</li>

</ul>

</dd>

<dt class="field-even">Returns</dt>

<dd class="field-even">out

</dd>

<dt class="field-odd">Return type</dt>

<dd class="field-odd">dict

</dd>

</dl>

Examples

‘>>> import_files()’

File Data_AprF_2019 is successfully imported

File Data_AugF_2019 is successfully imported

File Data_JulF_2019 is successfully imported

File Data_JunF_2019_v1 is successfully imported

File Data_MayF_2019 is successfully imported

File Data_SepP_2019 is successfully imported

‘>>> import_files(like = [‘Aug’,’Sep’])’

File Data_AugF_2019 is successfully imported

File Data_SepP_2019 is successfully imported

</dd></dl>

</div>

<h2>codonPython.nhsd_colours module<a class="headerlink" href="#module-codonPython.nhsd_colours" title="Permalink to this headline">¶</a></h2>

<code class="sig-prename descclassname">codonPython.nhsd_colours.</code><code class="sig-name descname">nhsd_colours</code>()<a class="headerlink" href="#codonPython.nhsd_colours.nhsd_colours" title="Permalink to this definition">¶</a></dt>

<dd>Returns a dictionary full of the different official NHSD colours from the

style guide:

<a class="reference external" href="https://digital.nhs.uk/about-nhs-digital/corporate-information-and-documents/nhs-digital-style-guidelines/how-we-look/colour-palette">https://digital.nhs.uk/about-nhs-digital/corporate-information-and-documents/nhs-digital-style-guidelines/how-we-look/colour-palette</a>

<dt class="field-odd">Parameters</dt>

<dd class="field-odd">None –

</dd>

<dt class="field-even">Returns</dt>

<dd class="field-even">colour_dict – A dictionary containing sets of official NHS Digital branding colours

(Hexidecimal format) and fonts.

</dd>

<dt class="field-odd">Return type</dt>

<dd class="field-odd">dict (Python dictionary)

</dd>

</dl>

</dd></dl>

<code class="sig-prename descclassname">codonPython.nhsd_colours.</code><code class="sig-name descname">nhsd_seaborn_style</code>()<a class="headerlink" href="#codonPython.nhsd_colours.nhsd_seaborn_style" title="Permalink to this definition">¶</a></dt>

<dd>Sets the seaborn style to be inline with NHSD guidlines. This means your

graphs in Seaborn, or in Matplotlib will come out looking as per the NHSD

style guide. Simply run this function.

<dt class="field-odd">Parameters</dt>

<dd class="field-odd">None –

</dd>

<dt class="field-even">Returns</dt>

</dd>

<dt class="field-odd">Return type</dt>

<dd class="field-odd">None

</dd>

</dl>

</dd></dl>

</div>

<h2>codonPython.nhsNumber module<a class="headerlink" href="#module-codonPython.nhsNumber" title="Permalink to this headline">¶</a></h2>

<code class="sig-prename descclassname">codonPython.nhsNumber.</code><code class="sig-name descname">nhsNumberGenerator</code>(to_generate: int, random_state: int = None) → list<a class="headerlink" href="#codonPython.nhsNumber.nhsNumberGenerator" title="Permalink to this definition">¶</a></dt>

<dd>Generates up to 1M random NHS numbers compliant with modulus 11 checks as recorded

in the data dictonary.

<a class="reference external" href="https://www.datadictionary.nhs.uk/data_dictionary/attributes/n/nhs/nhs_number_de.asp?shownav=1">https://www.datadictionary.nhs.uk/data_dictionary/attributes/n/nhs/nhs_number_de.asp?shownav=1</a>

<dt class="field-odd">Parameters</dt>

<li>to_generate (int) – number of NHS numbers to generate</li>

<li>random_state (int, default : None) – Optional seed for random number generation, for testing and reproducibility.</li>

</ul>

</dd>

<dt class="field-even">Returns</dt>

<dd class="field-even">generated – List of randomly generated NHS numbers

</dd>

<dt class="field-odd">Return type</dt>

<dd class="field-odd">list

</dd>

</dl>

Examples

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> nhsNumberGenerator(2, random_state=42)

[8429141456, 2625792787]

</pre></div>

</div>

</dd></dl>

<code class="sig-prename descclassname">codonPython.nhsNumber.</code><code class="sig-name descname">nhsNumberValidator</code>(number: int) → bool<a class="headerlink" href="#codonPython.nhsNumber.nhsNumberValidator" title="Permalink to this definition">¶</a></dt>

<dd>Validate NHS Number according to modulus 11 checks as recorded in the data dictionary.

<dt class="field-odd">Parameters</dt>

<dd class="field-odd">number (int) – 10 digit integer to validate.

</dd>

<dt class="field-even">Returns</dt>

<dd class="field-even">If the number passes modulus 11 checks a.k.a. is valid.

</dd>

<dt class="field-odd">Return type</dt>

<dd class="field-odd">bool

</dd>

</dl>

Examples

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> nhsNumberValidator(8429141456)

True

>>> nhsNumberValidator(8429141457)

False

</pre></div>

</div>

</dd></dl>

</div>

<h2>codonPython.suppression module<a class="headerlink" href="#module-codonPython.suppression" title="Permalink to this headline">¶</a></h2>

<code class="sig-prename descclassname">codonPython.suppression.</code><code class="sig-name descname">suppress_value</code>(valuein: int, rc: str = '*', upper: int = 100000000) → str<a class="headerlink" href="#codonPython.suppression.suppress_value" title="Permalink to this definition">¶</a></dt>

<dd>Suppress values less than or equal to 7, round all non-national values.

This function suppresses value if it is less than or equal to 7.

If value is 0 then it will remain as 0.

If value is at national level it will remain unsuppressed.

All other values will be rounded to the nearest 5.

<dt class="field-odd">Parameters</dt>

<li>valuein (int) – Metric value</li>

<li>rc (str) – Replacement character if value needs suppressing</li>

<li>upper (int) – Upper limit for suppression of numbers</li>

</ul>

</dd>

<dt class="field-even">Returns</dt>

<dd class="field-even">out – Suppressed value (*), 0 or valuein if greater than 7 or national

</dd>

<dt class="field-odd">Return type</dt>

<dd class="field-odd">str

</dd>

</dl>

Examples

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> suppress_value(3)

'*'

>>> suppress_value(24)

'25'

>>> suppress_value(0)

'0'

</pre></div>

</div>

</dd></dl>

</div>

<h2>codonPython.tableFromSql module<a class="headerlink" href="#module-codonPython.tableFromSql" title="Permalink to this headline">¶</a></h2>

<code class="sig-prename descclassname">codonPython.tableFromSql.</code><code class="sig-name descname">tableFromSql</code>(server: str, database: str, table_name: str, user: str = '', password: str = '', schema: str = None, index_col: str = None, coerce_float: bool = True, parse_dates: list = None, columns: list = None, chunksize: int = None)<a class="headerlink" href="#codonPython.tableFromSql.tableFromSql" title="Permalink to this definition">¶</a></dt>

<dd>Returns a SQL table in a DataFrame.

Convert a table stored in SQL Server 2016 into a pandas dataframe.

Uses sqlalchemy and pandas.

<dt class="field-odd">Parameters</dt>

<li>server (string) – Name of the SQL server</li>

<li>database (string) – Name of the SQL database</li>

<li>user (string, default: "") – If verification is required, name of the user</li>

<li>password (string, default: "") – If verification is required, password of the user</li>

<li>table_name (string) – Name of SQL table in database.</li>

<li>schema (string, default : None) – Name of SQL schema in database to query (if database flavor supports this). Uses

default schema if None (default).</li>

<li>index_col (string or list of strings, default : None) – Column(s) to set as index(MultiIndex).</li>

<li>coerce_float (boolean, default : True) – Attempts to convert values of non-string, non-numeric objects (like decimal.Decimal)

to floating point. Can result in loss of Precision.</li>

<li>parse_dates (list or dict, default : None) – <ul>

<li>List of column names to parse as dates.</li>

<li>Dict of {column_name: format string} where format string is strftime compatible in</li>

</ul>

case of parsing string times or is one of (D, s, ns, ms, us) in case of parsing

integer timestamps.

- Dict of {column_name: arg dict}, where the arg dict corresponds to the keyword

arguments of pandas.to_datetime() Especially useful with databases without native

Datetime support, such as SQLite.

</li>

<li>columns (list, default : None) – List of column names to select from SQL table</li>

<li>chunksize (int, default : None) – If specified, returns an iterator where chunksize is the number of rows to include

in each chunk.</li>

</ul>

</dd>

<dt class="field-even">Returns</dt>

<dd class="field-even">Dataframe of the table requested from sql server

</dd>

<dt class="field-odd">Return type</dt>

<dd class="field-odd">pd.DataFrame

</dd>

</dl>

Examples

# >>> tableFromSql(“myServer2”, “myDatabase2”, “myTable2”)

# pd.DataFrame

# >>> tableFromSql(“myServer”, “myDatabase”, “myTable”, schema=”specialSchema”, columns=[“col_1”, “col_3”])

# pd.DataFrame

</dd></dl>

</div>

<h2>codonPython.tolerance module<a class="headerlink" href="#module-codonPython.tolerance" title="Permalink to this headline">¶</a></h2>

<code class="sig-prename descclassname">codonPython.tolerance.</code><code class="sig-name descname">check_tolerance</code>(t, y, to_exclude: int = 1, poly_features: list = [1, 2], alpha: float = 0.05, parse_dates: bool = False, predict_all: bool = False) → pandas.core.frame.DataFrame<a class="headerlink" href="#codonPython.tolerance.check_tolerance" title="Permalink to this definition">¶</a></dt>

<dd>Check that some future values are within a weighted least squares confidence interval.

<dt class="field-odd">Parameters</dt>

<li>t (pd.Series) – N explanatory time points of shape (N, 1).</li>

<li>y (pd.Series) – The corresponding response variable values to X, of shape (N, 1).</li>

<li>to_exclude (int, default = 1) – How many of the last y values will have their tolerances checked.</li>

<li>poly_features (list, default = [1, 2]) – List of degrees of polynomial basis to fit to the data. One model will be

produced for each number in the list, eg. the default will fit a linear and

a second degree polynomial to the data and return both sets of results.</li>

<li>alpha (float, default = 0.05) – Alpha parameter for the weighted least squares confidence interval.</li>

<li>parse_dates (bool, default = True) – Set to true to parse string dates in t</li>

<li>predict_all (bool, default = False) – Set to true to show predictions for all points of the dataset.</li>

</ul>

</dd>

<dt class="field-even">Returns</dt>

<dt>DataFrame containing:</dt><dd>”t” : Value for t

“yhat_u” : Upper condfidence interval for y

“yobs” : Observed value for y

“yhat” : Predicted value for y

“yhat_l” : Lower confidence interval for y

“polynomial”: Max polynomial of model fit to the data

</dd>

</dl>

</dd>

<dt class="field-odd">Return type</dt>

<dd class="field-odd">pd.DataFrame

</dd>

</dl>

Examples

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> check_tolerance(

... t = pd.Series([1001,1002,1003,1004,1005,1006]),

... y = pd.Series([2,3,4,4.5,5,5.1]),

... to_exclude = 2,

... )

t yhat_u yobs yhat yhat_l polynomial

0 1005 6.817413 5.0 5.500 4.182587 1

1 1006 7.952702 5.1 6.350 4.747298 1

2 1005 9.077182 5.0 4.875 0.672818 2

3 1006 13.252339 5.1 4.975 -3.302339 2

</pre></div>

</div>

</dd></dl>

</div>

<h2>Module contents<a class="headerlink" href="#module-codonPython" title="Permalink to this headline">¶</a></h2>

</div>

<a href="modules.html" class="btn btn-neutral float-left" title="codonPython" accesskey="p" rel="prev"> Previous</a>

</div>

<hr/>

</div>

Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>

</div>

</section>

</div>

jQuery(function () {

SphinxRtdTheme.Navigation.enable(true);

});

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

codonPython.html

Latest commit

History

codonPython.html

File metadata and controls