Merge branch 'main' into lrnv/issue98

.github/workflows/CI.yml

@@ -41,6 +41,9 @@ jobs:
   docs:
     name: Documentation
     runs-on: ubuntu-latest
+    if: >-
+        !contains(github.event.head_commit.message, '[skip docs]')
+        && github.event_name != 'pull_request'
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v1

README.md

@@ -56,8 +56,7 @@ D = SklarDist(C,(X₁,X₂,X₃)) # The final distribution
 simu = rand(D,1000) # Generate a dataset
 
 # You may estimate a copula using the `fit` function:
-D̂ = fit(SklarDist{FrankCopula,Tuple{Gamma,Normal,LogNormal}}, simu)
-# Increase the number of observations to get a beter fit (or not?)  
+D̂ = fit(SklarDist{ClaytonCopula,Tuple{Gamma,Normal,LogNormal}}, simu)
 ```
 
 The list of availiable copula models is *very* large, check it out on our [documentation](https://lrnv.github.io/Copulas.jl/stable) ! 
@@ -72,7 +71,7 @@ There are competing packages in Julia, such as [`BivariateCopulas.jl`](https://g
 |  | `Copulas.jl` | `DatagenCopulaBased.jl` | `BivariateCopulas.jl` |
 |----------------|--------------|-------------------------|-----------------------|
 | `Distributions.jl`'s API | ✔️ | ❌ | ✔️ |
-| Fitting                  | ✔️ | ✔️ | ❌ |
+| Fitting                  | ✔️ | ❌ | ❌ |
 | Plotting                 | ❌ | ❌ | ✔️ |
 | Available copulas        |     |     |    |
 | - Classic Bivariate      | ✔️ | ✔️ | ✔️ |