Add decimals to roundings (#6)

* Add decimals to rounding

Author: PyDataBlog

.github/workflows/CI.yml

@@ -10,7 +10,7 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1.0'
+          - '1.1'
           - '1.6'
           - 'nightly'
         os:

Project.toml

@@ -1,7 +1,7 @@
 name = "InstaRound"
 uuid = "609f54d3-8a97-4836-aa37-e3dc8f03ac88"
-authors = ["PyDataBlog <pimpfada@gmail.com> and contributors"]
-version = "0.1.0"
+authors = ["PyDataBlog <pimpfada@gmail.com>"]
+version = "0.2.0"
 
 [compat]
 julia = "1"

README.md

@@ -5,7 +5,7 @@
 [![Build Status](https://github.com/PyDataBlog/InstaRound.jl/workflows/CI/badge.svg)](https://github.com/PyDataBlog/InstaRound.jl/actions)
 [![Coverage](https://codecov.io/gh/PyDataBlog/InstaRound.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/PyDataBlog/InstaRound.jl)
 
-A simple package for extending Base.round with instagram-like rounding.
+A simple package for extending Base.round with a more human readable rounding style.
 
 ## Installation
 
@@ -30,8 +30,8 @@ Round numbers with IGRound
 using InstaRound
 
 julia> round(IGRound, 1_000_000; names=false)
-"1M"
+"1.0M"
 
 julia> round(IGRound, 1_000_000; names=true)
-"1Million"
+"1.0 Million"
 ```

docs/src/index.md

@@ -21,42 +21,73 @@ or switch to `Pkg` mode with `]` and issue
 
 ```julia
 pkg> add InstaRound
+```
 
 ## Basic Usage
+
 Round numbers with IGRound
 
 ```julia
 using InstaRound
 
 julia> round(IGRound, 1_000_000; names=false)
-"1M"
+"1.0M"
+
+julia> round(IGRound, 1_000_000; names=true)
+"1.0 Million"
 ```
 
 ## Practical Use Case
 
 ```julia
 using InstaRound
-using MarketData
-using Dates
+using PolygonIO
+using DataFrames
 
 
+opts = PolyOpts(API_KEY, DataFrame)
+bars_df = crypto_aggregates_bars(opts, "X:BTCUSD", 5, "minute", "2020-10-14", "2020-10-16")
+```
 
-start = DateTime(2017, 1, 1)
-df = yahoo(:AMZN, YahooOpt(period1 = start))
+```julia-repl
+julia> round.(IGRound, bars_df.c; names=false)
+24-element Vector{String}:
+ "11.42K"
+ "11.42K"
+ "11.44K"
+ "11.45K"
+ "11.45K"
+ "11.45K"
+ "11.45K"
+ ⋮
+ "11.44K"
+ "11.44K"
+ "11.44K"
+ "11.45K"
+ "11.45K"
+ "11.45K"
+ "11.44K"
 ```
 
-```julia
-julia> round.(IGRound, df.AdjClose; names=false)
-1137×1 TimeArray{String, 1, Date, Vector{String}} 2017-01-03 to 2021-07-09
-│            │ AdjClose │
-├────────────┼──────────┤
-│ 2017-01-03 │ "754"    │
-│ 2017-01-04 │ "757"    │
-│ 2017-01-05 │ "780"    │
-│ ⋮          │ ⋮        │
-│ 2021-07-07 │ "3K"     │
-│ 2021-07-08 │ "3K"     │
-│ 2021-07-09 │ "3K"     │
+```julia-repl
+julia> round.(IGRound, bars_df.c; names=true)
+24-element Vector{String}:
+ "11.42 Thousand"
+ "11.42 Thousand"
+ "11.44 Thousand"
+ "11.45 Thousand"
+ "11.45 Thousand"
+ "11.45 Thousand"
+ "11.45 Thousand"
+ ⋮
+ "11.44 Thousand"
+ "11.44 Thousand"
+ "11.44 Thousand"
+ "11.45 Thousand"
+ "11.45 Thousand"
+ "11.45 Thousand"
+ "11.44 Thousand"
+
 ```
 
 ## Abbreviation Source

src/utils.jl

@@ -23,6 +23,23 @@ function business_round(number::Number, names::Bool)
 end
 
 
+"""
+    number_groups(s::AbstractString)
+
+Internal function to extract the two groups of numbers from a '.' separated string.
+"""
+function number_groups(s::AbstractString)
+    group_1 = match(r"(\d+)", s)[1]
+    group_2 = match(r"(\d+$)", s)[1]
+
+    if length(group_2) > 1
+        group_2 = group_2[1:2]
+    else
+        group_2 = group_2[1]
+    end
+    return group_1, group_2
+end
+
 """
     extract_identifying_unit(num::Number, names::Bool)
 
@@ -37,9 +54,15 @@ function extract_identifying_unit(num::Number, names::Bool)
     else
         unit = units[div_3]
     end
-    identifier = num / ( BigInt(10) ^ (3 * div_3) ) |> x -> string(floor(Int, x))
 
-    return string(identifier, unit)
+    indentifier = string(num / ( BigInt(10) ^ (3 * div_3) ))
+    main_int, rem_float = number_groups(indentifier)
+
+    if names
+        return string(main_int, ".", rem_float, " ", unit)
+    else
+        return string(main_int, ".", rem_float, unit)
+    end
 end