Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
carstenbauer authored Feb 22, 2019
1 parent c49f9fd commit dd0e8dc
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,12 @@ append!(B, [1,2,3]) # multiple values at once
x = mean(B)
Δx = std_error(B) # standard error of the mean
tau_x = tau(B) # autocorrelation time

# Alternatively you can provide a time series already in the constructor
x = rand(100)
B = LogBinner(x)

Δx = std_error(B)
```

<!--
Expand All @@ -62,14 +68,21 @@ has_converged(B, 3)
### Full Binning

```julia
x = rand(1000)
B = FullBinner(x) # just a thin wrapper <: AbstractVector
B = FullBinner() # <: AbstractVector (lightweight wrapper)

push!(B, 2.0) # will modify x
push!(B, 2.0)
append!(B, [1,2,3])

x = mean(B)
Δx = std_error(B) # standard error of the mean

# Alternatively you can provide a time series already in the constructor
x = rand(100)
F = FullBinner(x)

push!(F, 2.0) # will modify x as F is just a thin wrapper

Δx = std_error(F)
```

## Resampling methods
Expand Down

0 comments on commit dd0e8dc

Please sign in to comment.