Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Urgent update main #252

Merged
merged 7 commits into from
Feb 24, 2023
Merged

Urgent update main #252

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4ad7655
add Survey mentions
smishr Feb 23, 2023
f5160a3
docs_update_urgent
smishr Feb 23, 2023
4aa1419
add ayush email
smishr Feb 23, 2023
b7e9077
Update Project.toml
smishr Feb 23, 2023
984b976
Update Project.toml
smishr Feb 23, 2023
b9f8e12
Update Project.toml
smishr Feb 24, 2023
c4a6965
Update src/Survey.jl
smishr Feb 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name = "Survey"
uuid = "c1a98b4d-6cd2-47ec-b9e9-69b59c35373c"
authors = ["Ayush Patnaik"]
authors = ["Ayush Patnaik <[email protected]>"]
version = "0.1.0"

[deps]
Expand All @@ -11,6 +11,7 @@ CategoricalArrays = "324d7699-5711-5eae-9e2f-1d82baa6b597"
DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
Missings = "e1d29d7a-bbdc-5cf2-9ac0-f12de2c33e28"
RData = "df47a6cb-8c03-5eed-afd8-b6050d6c41da"
smishr marked this conversation as resolved.
Show resolved Hide resolved
Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ All types of survey design are supported by this package.

## Installation
```julia
] add "https://github.com/xKDR/Survey.jl.git"
] add Survey
```

## Basic usage
Expand Down
9 changes: 1 addition & 8 deletions docs/src/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
## Installation

The `Survey.jl` package is not yet registered. For now, installation of the package
is done using the following command:

```julia
] add "https://github.com/xKDR/Survey.jl.git"
```

After registration, the regular `Pkg` commands can be used for installing the package:
The `Survey.jl` package is registered. Regular `Pkg` commands can be used for installing the package:

```@repl
using Pkg
Expand Down
2 changes: 2 additions & 0 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Sizes of survey datasets have also been growing with advances in computing power

Several software tools are available to study complex surveys[^1]. The [survey package in R](https://cran.r-project.org/web/packages/survey/index.html) is a widely used open-source package.

Discourse [post](https://discourse.julialang.org/t/ann-announcing-survey-jl-for-analysis-of-complex-surveys/94667) announcing the package.

## Current features
Presently, summary statistics such as `mean`, `total`, `ratio`, and `quantile` can be estimated for whole of sample as well as subpopulations/domains using this package. Variance estimation for these estimators are performed using Rao-Wu bootstrap[^2]. Basic visualisations such a scatter plot, histogram and box plot can also be generated.

Expand Down
1 change: 1 addition & 0 deletions src/Survey.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ using AlgebraOfGraphics
using CategoricalArrays
using Random
using Missings
using RData
smishr marked this conversation as resolved.
Show resolved Hide resolved

include("SurveyDesign.jl")
include("bootstrap.jl")
Expand Down