From bfc9b34bfc576a8c36c1969eefb9e29182aa1647 Mon Sep 17 00:00:00 2001
From: Bergant <darko.bergant@adacta.si>
Date: Sat, 11 Apr 2015 19:23:40 +0200
Subject: [PATCH] readme

readme
---
 README.Rmd             | 17 +++++++++--------
 readme.md              |  8 ++++----
 vignettes/Overview.Rmd |  8 ++++----
 3 files changed, 17 insertions(+), 16 deletions(-)

diff --git a/README.Rmd b/README.Rmd
index 725e856..6558fc6 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -28,7 +28,7 @@ For now it is offering:
 **1. Data structure for financial statements**
 
   - Reading from data frames parsed with XBRL package
-  - Structure in tidy format
+  - Statements in tidy format with accounting taxonomy concepts as columns
   - Encapsulating calculation hierarchy of variables
   - Default printing in transposed format and with visible hierarchy
 
@@ -261,7 +261,7 @@ income2014 %>% do_calculation(profit_margins)
 ## Rearranging statement hierarchy
 Calculations gives us freedom to use any formula with any data from 
 financial statements.
-Most of the time this is not necessary as we can get usefull information just by
+Most of the time this is not necessary as we can get useful information just by
 regrouping calculation hierarchy.
 
 There are many additional reasons why is rearranging statements useful step before
@@ -274,7 +274,7 @@ actual calculations:
       
 To rearrange the statement to simple 2-level hierarchy use `expose` function.
 
-```{r expose_graph}
+```{r expose}
 expose( balance_sheet,
   
   # Assets
@@ -290,8 +290,8 @@ expose( balance_sheet,
 ```
 
 Balance sheet stays divided by *Assets* and *Liabilities and Equity*.
-For the second level we are exposing current assets from noncurrent and 
-similar is done for the liabilities. We choose to separate equity.
+For the second level we are exposing *current assets* from *noncurrent* and 
+similar is done for the *liabilities*. We choose to separate *equity*.
 
 Function `expose` expects a list of vectors with element names.
 Function `other` helps us identify elements without enumerating every single element.
@@ -300,8 +300,8 @@ elements are not specified and keeps the balance sheet complete.
 
 
 Sometimes it is easier to define a complement than a list of elements.
-In this case we can use the `%without%` operator. Let say we
-want to expose first tangible and then intangible assets:
+In this case we can use the `%without%` operator. Lets expose for example
+*tangible* and then *intangible* assets:
 
 ```{r expose_without}
 expose( balance_sheet,
@@ -328,6 +328,7 @@ diff(balance_sheet)
 
 ```
 
+
 # Balance sheet visualization
 
 ## Prepare custom hierarchy
@@ -335,7 +336,7 @@ The only way to visualize a balance sheet is by exposing a limited number of val
 The first step is then to aggregate a balance sheet to a small number of pieces.
 We can use `expose` to specify these groups of elements. For example:
 
-```{r expose}
+```{r expose_graph}
 bs_simple <- expose( balance_sheet,
   
   # Assets
diff --git a/readme.md b/readme.md
index 9893620..c227cac 100644
--- a/readme.md
+++ b/readme.md
@@ -8,7 +8,7 @@ For now it is offering:
 **1. Data structure for financial statements**
 
 -   Reading from data frames parsed with XBRL package
--   Structure in tidy format
+-   Statements in tidy format with accounting taxonomy concepts as columns
 -   Encapsulating calculation hierarchy of variables
 -   Default printing in transposed format and with visible hierarchy
 
@@ -314,7 +314,7 @@ income2014 %>% do_calculation(profit_margins)
 Rearranging statement hierarchy
 -------------------------------
 
-Calculations gives us freedom to use any formula with any data from financial statements. Most of the time this is not necessary as we can get usefull information just by regrouping calculation hierarchy.
+Calculations gives us freedom to use any formula with any data from financial statements. Most of the time this is not necessary as we can get useful information just by regrouping calculation hierarchy.
 
 There are many additional reasons why is rearranging statements useful step before actual calculations:
 
@@ -348,11 +348,11 @@ expose( balance_sheet,
 #> + Stockholders.Equity               111547     123549     118210
 ```
 
-Balance sheet stays divided by *Assets* and *Liabilities and Equity*. For the second level we are exposing current assets from noncurrent and similar is done for the liabilities. We choose to separate equity.
+Balance sheet stays divided by *Assets* and *Liabilities and Equity*. For the second level we are exposing *current assets* from *noncurrent* and similar is done for the *liabilities*. We choose to separate *equity*.
 
 Function `expose` expects a list of vectors with element names. Function `other` helps us identify elements without enumerating every single element. Using `other` reduces a lot of potential errors as the function "knows" which elements are not specified and keeps the balance sheet complete.
 
-Sometimes it is easier to define a complement than a list of elements. In this case we can use the `%without%` operator. Let say we want to expose first tangible and then intangible assets:
+Sometimes it is easier to define a complement than a list of elements. In this case we can use the `%without%` operator. Lets expose for example *tangible* and then *intangible* assets:
 
 ``` {.r}
 expose( balance_sheet,
diff --git a/vignettes/Overview.Rmd b/vignettes/Overview.Rmd
index 2075ec0..8b9cfae 100644
--- a/vignettes/Overview.Rmd
+++ b/vignettes/Overview.Rmd
@@ -22,7 +22,7 @@ For now it is offering:
 **1. Data structure for financial statements**
 
   - Reading from data frames parsed with XBRL package
-  - Structure in tidy format
+  - Statements in tidy format with accounting taxonomy concepts as columns
   - Encapsulating calculation hierarchy of variables
   - Default printing in transposed format and with visible hierarchy
 
@@ -255,7 +255,7 @@ income2014 %>% do_calculation(profit_margins)
 ## Rearranging statement hierarchy
 Calculations gives us freedom to use any formula with any data from 
 financial statements.
-Most of the time this is not necessary as we can get usefull information just by
+Most of the time this is not necessary as we can get useful information just by
 regrouping calculation hierarchy.
 
 There are many additional reasons why is rearranging statements useful step before
@@ -294,8 +294,8 @@ elements are not specified and keeps the balance sheet complete.
 
 
 Sometimes it is easier to define a complement than a list of elements.
-In this case we can use the `%without%` operator. Let say we
-want to expose first tangible and then intangible assets:
+In this case we can use the `%without%` operator. Lets expose for example
+*tangible* and then *intangible* assets:
 
 ```{r expose_without}
 expose( balance_sheet,
-- 
GitLab