set up documentation using Documenter.jl #4
Conversation
src/statistics.jl
Outdated
| Returns autocorrelation function for a distance of lag, i.e. between values of | ||
| ```x[t]``` and ```x[t+lag]```. The autocorrelation function is normalized such | ||
| that ```autocor(x,0) = 1```. This is equvivalent to the quantity | ||
| ``\\Gamma_X(t)`` of equation (4.61) in Gattringer/Lang. |
There was a problem hiding this comment.
Better citation of the book would be nice.
Is there anything in documenter.jl to have something like a "Reference"-section with Bibliography to link to?
There was a problem hiding this comment.
It turns out that there is a dedicated plug-in package for this DocumenterCitations.jl . I had to modify the standard .bib entries generated by inspire for it to work and the bibliography style cannot be customized (yet) (see ali-ramadhan/DocumenterCitations.jl#22 ) but this should do it for now.
| # Autocorrelation for a specifig lag | ||
| function autocor(x::AbstractVector, lag::Integer) | ||
| """ | ||
| autocor(x,lag) |
There was a problem hiding this comment.
Any specific reason I miss for calling it lag?
There was a problem hiding this comment.
It is the same name that is being used in StatsBase.jl - we could call it something else. Calling it time or t could be misleading but maybe something like steps or timesteps?
There was a problem hiding this comment.
Okay yes makes sense to stick to something that has already been around for some time.
|
I am fine with merging for now. |
|
I have added a separate |
|
Good question. |
Enable citations in docs using DocumenterCitations.jl add separate Project.toml file for docs
+ Enable citations in docs using DocumenterCitations.jl + add separate Project.toml file for docs
This sets up the file structure for automatically creating docs using Documenter.jl. As an example I have added docs for the autocorrelation functions. To create docs locally make sure that Documenter.jl is added to your global environment (the same environment as e.g. Revise) and run the docs/make.jl file. The documentation can then be found at docs/build/index.html