Skip to content

Commit 7c7fa98

Browse files
committed
Docs; gitignore
1 parent 8d7e1dc commit 7c7fa98

File tree

2 files changed

+20
-19
lines changed

2 files changed

+20
-19
lines changed

.gitignore

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
*.doc
2+
*.docx
3+
*.ini
4+
*.jl.*.cov
5+
*.jl.cov
6+
*.jl.mem
7+
*.ods
8+
*.odt
9+
*.pdf
10+
*.swp
11+
*.tab
12+
*.xlsx
13+
.~lock*
14+
/docs/build/
15+
Manifest.toml

docs/src/index.md

Lines changed: 5 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,16 @@
22
CurrentModule = SurveyDataWeighting
33
```
44

5-
# SurveyDataWeighting
5+
# SurveyDataWeighting: Generating Sample Weights for a dataset
66

7-
```@index
8-
```
97

10-
```@autodocs
11-
Modules = [SurveyDataWeighting]
8+
```@index
129
```
1310

14-
# Generating Weights for a dataset
15-
16-
17-
This generates weights for a sample dataset such that weighted sums of dataset
18-
columns match some set of targets. For example, you might want to weight a
19-
dataset so that it matches known amounts of benefit receipts or numbers of
11+
This generates weights for a sample dataset such that weighted sums of dataset columns match some set of targets. For example, you might want to weight a dataset so that it matches known amounts of benefit receipts or numbers of
2012
households in different regions of a country, or both.
2113

22-
A commercial product [Calmar](http://vesselinov.com/CalmarEngDoc.pdf) is
23-
available for this, and widely used, but there are many advantages in having a
24-
version that you can easily embed in a simulation program. It can be very useful
25-
for producing forecasts, for example; see the papers by Reed and Stark and
26-
Creedy in [the bibliography](biblio.md).
14+
A commercial product [Calmar](http://vesselinov.com/CalmarEngDoc.pdf) is available for this, and widely used, but there are many advantages in having a version that you can easily embed in a simulation program. It can be very useful for producing forecasts, for example; see the papers by Reed and Stark and Creedy below.
2715

2816
The routine calculates a set of weights that are closest in some sense to an
2917
initial set of weights such that, when summed, the weighted data hits the
@@ -44,8 +32,7 @@ function doreweighting(
4432
tolf :: Real = 0.000001 ) :: Dict{ Symbol, Any }
4533

4634
```
47-
See the [testcase](../test/reweighter_tests.jl) for a simple example, based on
48-
examples from the Creedy paper.
35+
See the for a simple example, based on examples from the Creedy paper.
4936

5037
The form of 'closeness' used is determined by the `functiontype` parameter of
5138
enumerated type `DistanceFunctionType`. See the [Creedy and Deville and
@@ -63,7 +50,6 @@ Modules = [BudgetConstraints]
6350
[:constant, :type, :function]
6451
```
6552

66-
6753
## TODO
6854

6955
* I really need to use standard Julia optimiser packages, such as [Optim.jl](https://github.com/JuliaNLSolvers/Optim.jl). I was pushed for time, though;

0 commit comments

Comments
 (0)