Improve documentation for new design, continuation of draft PR #49 #54

iuliadmtru · 2022-09-07T12:41:35Z

This is a continuation of my draft PR #49 which comes from a different branch (docs_improve instead of design_update). I will close PR #49 and continue working on this PR.

…_data`

…nto design_update

… and `svytotal`

Improved SRS Design with args error checking, better types

Design update merge Stratified Sample mean total and variance estimators

Add test cases and change `...` to `reduce`

…e file

…-13-02-09-54-577-01107001681 CompatHelper: bump compat for CairoMakie to 0.9, (keep existing compat)

Minor corrections

Synch branch with main

…ocs_improve

iuliadmtru · 2022-10-17T19:02:48Z

I think I messed up using git.. The code is fine, but the history is all cluttered. Sorry about that! :(

codecov-commenter · 2022-10-31T19:59:52Z

Codecov Report

Merging #54 (72ce5a1) into design_update (aa0715a) will decrease coverage by 17.42%.
The diff coverage is 15.88%.

❗ Current head 72ce5a1 differs from pull request most recent head 93c686c. Consider uploading reports for the commit 93c686c to get more accurate results

@@                Coverage Diff                 @@
##           design_update      #54       +/-   ##
==================================================
- Coverage          55.26%   37.83%   -17.43%     
==================================================
  Files                 12       14        +2     
  Lines                266      370      +104     
==================================================
- Hits                 147      140        -7     
- Misses               119      230      +111

Impacted Files	Coverage Δ
src/dimnames.jl	`100.00% <ø> (ø)`
src/ht.jl	`0.00% <0.00%> (ø)`
src/show.jl	`0.00% <0.00%> (ø)`
src/svyboxplot.jl	`50.00% <ø> (ø)`
src/svyby.jl	`0.00% <ø> (ø)`
src/svydesign.jl	`57.89% <ø> (+12.28%)`	⬆️
src/svyglm.jl	`97.50% <ø> (+14.52%)`	⬆️
src/svyhist.jl	`57.89% <ø> (-36.85%)`	⬇️
src/svyplot.jl	`50.00% <ø> (ø)`
src/svymean.jl	`11.11% <5.35%> (-38.89%)`	⬇️
... and 9 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

iuliadmtru · 2022-10-31T20:02:43Z

This is a very long PR containing documentation work. It is not completely up to date (or at least it won't be up to date when PR #69 is merged). I think we can manage the conflicts.

Edit: I added more details about the changes I made.

All doctests pass now and are correct. They are updated according to the new design. Docstrings can be further improved by adding examples that use datasets other than api.
The docs/src/index.md file has been changed to resemble documentation pages from other Julia packages. It is now structured to show a short description of the package, the index and API of package functions and types.
example.md is now well structured and contains a tutorial on using the package. It is not complete, it needs great improvement.
I added descriptive comments at some places in the source code. More comments ideally should be added.

ayushpatnaikgit · 2022-11-01T10:36:37Z

src/ht.jl

@@ -0,0 +1,17 @@
+# TODO: add docstrings
+function HorwitzThompson_HartleyRaoApproximation(y::AbstractVector, design::AbstractSurveyDesign, HT_total)


Why are these modifications part of this PR?

These come from my git mess up. I merged this branch with the design_update branch at some point in a wrong way.

ayushpatnaikgit · 2022-11-01T10:38:16Z

src/svymean.jl

+
+# StratifiedSample
+
+function svymean(x::Symbol, design::StratifiedSample)


This also shouldn't be part of this PR

I believe this is the same git mess up.

smishr and others added 5 commits September 5, 2022 13:55

Add sampfraction ignorefpc to print function

d840ed4

Add type specification (Symbol) for first argument of svymean

67aeb5e

Add Index and API to the documentation, incomplete

62b60aa

Add error checks key args of SRS contructor

de5524c

Rename "example.jl" to "load_data.jl", change documentation for `load…

298c41f

…_data`

iuliadmtru mentioned this pull request Sep 7, 2022

Documentation upgrade for new design #49

Closed

iuliadmtru and others added 24 commits September 7, 2022 16:14

Add documentation for load_data

7176b42

Merge branch 'xKDR:design_update' into design_update

f6c16d0

Merge branch 'design_update' into design_update

a7f5df5

save commits Add isa for categorical variables

e4c5216

Merge branch 'design_update' of https://github.com/smishr/Survey.jl i…

f35be8a

…nto design_update

Pull changes from design_update and add documentation for svymean…

c802774

… and `svytotal`

Redid old PR update, changed/updated tests for new design

5623a16

Add svymean categoricalarray functionality

862b236

Add svytotal CategoricalArray output support

a0d3544

edit column name from count to counts

1ef381d

Merge pull request xKDR#53 from smishr/design_update

06f9bbd

Improved SRS Design with args error checking, better types

Add Stratified Sample object struct

8a4d12c

Add svymean mutliple dispatch and support Stratified mean

f990e6d

Merge branch 'xKDR:design_update' into design_update

04f3d84

Add sbytotal for Stratified

5f398c7

demerge

a1b0e28

Add variance for StratifiedSample svymean and svytotal

86f8ed4

Add categorical support svytotal svymean, not fully correct yet

84a2636

svytotal strata case

13c829f

Shikhar manual testing code

e93ae7a

Merge pull request xKDR#58 from smishr/design_update

1bfdfa9

Design update merge Stratified Sample mean total and variance estimators

Change ... to reduce.

d25f884

Merge pull request xKDR#61 from sayantikaSSG/design_update

d1bf631

Add test cases and change `...` to `reduce`

Remove duplicate code and comments and rephrase error messages for SRS

9c68108

iuliadmtru and others added 11 commits October 15, 2022 19:38

Remove and rephrase comments

466cc35

Remove comments

21d784d

Remove and rephrase comments

2b4f4a6

Remove and rephrase comments

44079c6

Implement new function for nice printing and move show to a separat…

86d139d

…e file

Merge pull request xKDR#62 from xKDR/compathelper/new_version/2022-10…

2ba7766

…-13-02-09-54-577-01107001681 CompatHelper: bump compat for CairoMakie to 0.9, (keep existing compat)

Merge pull request xKDR#63 from iuliadmtru/minor_corrections

ffea267

Minor corrections

Merge pull request xKDR#65 from xKDR/main

e2a35b6

Synch branch with main

Merge branch 'xKDR:main' into docs_improve

6151336

Pull and integrate changes from design_update and main

0a110cd

Merge branch 'docs_improve' of github.com:iuliadmtru/Survey.jl into d…

5668157

…ocs_improve

iuliadmtru added 7 commits October 23, 2022 12:03

Rephrase and reorder docstrings

406eb4a

Correct show for svydesign and move it to the show.jl file

96cfd2f

Include show.jl after svydesign.jl

48c3851

Correct doctests

40685c7

Rename GeneralSample back to ClusterSample

4c5d5e7

Correct the path for doc image

3f52fc5

Rephrase and remove outdated documentation

93c686c

iuliadmtru marked this pull request as ready for review October 31, 2022 19:59

iuliadmtru requested review from ayushpatnaikgit and smishr October 31, 2022 20:00

ayushpatnaikgit reviewed Nov 1, 2022

View reviewed changes

ayushpatnaikgit approved these changes Nov 1, 2022

View reviewed changes

ayushpatnaikgit merged commit f2f0042 into xKDR:design_update Nov 1, 2022

iuliadmtru deleted the docs_improve branch November 4, 2022 12:02

iuliadmtru mentioned this pull request Nov 4, 2022

Doctests giving warnings and unnecessary output #42

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve documentation for new design, continuation of draft PR #49 #54

Improve documentation for new design, continuation of draft PR #49 #54

iuliadmtru commented Sep 7, 2022

iuliadmtru commented Oct 17, 2022

codecov-commenter commented Oct 31, 2022

iuliadmtru commented Oct 31, 2022 •

edited

Loading

ayushpatnaikgit Nov 1, 2022

iuliadmtru Nov 1, 2022

ayushpatnaikgit Nov 1, 2022

iuliadmtru Nov 1, 2022

		@@ -0,0 +1,17 @@
		# TODO: add docstrings
		function HorwitzThompson_HartleyRaoApproximation(y::AbstractVector, design::AbstractSurveyDesign, HT_total)


		# StratifiedSample

		function svymean(x::Symbol, design::StratifiedSample)

Improve documentation for new design, continuation of draft PR #49 #54

Improve documentation for new design, continuation of draft PR #49 #54

Conversation

iuliadmtru commented Sep 7, 2022

iuliadmtru commented Oct 17, 2022

codecov-commenter commented Oct 31, 2022

Codecov Report

iuliadmtru commented Oct 31, 2022 • edited Loading

ayushpatnaikgit Nov 1, 2022

Choose a reason for hiding this comment

iuliadmtru Nov 1, 2022

Choose a reason for hiding this comment

ayushpatnaikgit Nov 1, 2022

Choose a reason for hiding this comment

iuliadmtru Nov 1, 2022

Choose a reason for hiding this comment

iuliadmtru commented Oct 31, 2022 •

edited

Loading