Update documentation

javierbarbero · Aug 3, 2020 · edfb0ea · edfb0ea
1 parent e401936
commit edfb0ea
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 5 deletions.
diff --git a/docs/src/technical/directional.md b/docs/src/technical/directional.md
@@ -100,9 +100,21 @@ julia> efficiency(deaddfvrs)
   0.0     
 ```
 
-The optimal peers, ``λ``, are returned with the `peers` function and are returned as a `SparseArrays.SparseMatrixCSC{Float64,Int64}` object:
+The optimal peers, ``λ``, are returned with the `peers` function and are returned as a `DEAPeers` object:
 ```julia
-peers(deaddfvrs)
+julia> peers(deaddfvrs)
+DEA Peers
+1: 1 ( 1.0 ) 
+2: 1 ( 0.4981132075471699 ) 6 ( 0.22830188679245278 ) 7 ( 0.2735849056603774 ) 
+3: 3 ( 1.0 ) 
+4: 4 ( 1.0 ) 
+5: 1 ( 0.5132075471698113 ) 6 ( 0.4018867924528304 ) 7 ( 0.08490566037735842 ) 
+6: 6 ( 1.0 ) 
+7: 7 ( 1.0 ) 
+8: 8 ( 1.0 ) 
+9: 9 ( 1.0 ) 
+10: 9 ( 1.0000000000000002 ) 
+11: 1 ( 1.0 ) 
 ```
 ### deaddf Function Documentation
 

diff --git a/docs/src/technical/radial.md b/docs/src/technical/radial.md
@@ -96,9 +96,21 @@ julia> efficiency(deaiovrs)
  1.0
 ```
 
-The optimal peers, ``λ``, are returned with the `peers` function and are returned as a `SparseArrays.SparseMatrixCSC{Float64,Int64}` object:
-```julia
-peers(deaiovrs)
+The optimal peers, ``λ``, are returned with the `peers` function and are returned as a `DEAPeers` object:
+```jldoctest 1
+julia> peers(deaiovrs)
+DEA Peers
+1: 1 ( 1.0 ) 
+2: 1 ( 0.5255878284923927 ) 6 ( 0.2842323651452281 ) 7 ( 0.1901798063623792 ) 
+3: 3 ( 1.0000000000000002 ) 
+4: 4 ( 1.0 ) 
+5: 1 ( 0.5661375661375662 ) 6 ( 0.4338624338624339 ) 
+6: 6 ( 1.0 ) 
+7: 7 ( 1.0 ) 
+8: 8 ( 0.9999999999999999 ) 
+9: 9 ( 1.0 ) 
+10: 1 ( 0.03711078928312814 ) 4 ( 0.4433381607530775 ) 7 ( 0.5195510499637944 ) 
+11: 11 ( 1.0 ) 
 ```