From 411b081a2633550d3a9bbd5a6593cced569171db Mon Sep 17 00:00:00 2001
From: Lukas Schneiderbauer <lukas.schneiderbauer@gmail.com>
Date: Sun, 9 Jun 2024 21:09:44 +0200
Subject: [PATCH] README: improve example comments

---
 README.Rmd | 7 +++----
 README.md  | 7 +++----
 2 files changed, 6 insertions(+), 8 deletions(-)

diff --git a/README.Rmd b/README.Rmd
index 9f8a71d..e1bab4e 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -64,7 +64,7 @@ This is a basic example that invokes the fcwt library to calculate the continuou
 ```{r example}
 library(fcwtr)
 
-# You are given some signal encoded in a numeric vector.
+# A signal encoded in a numeric vector.
 # In this example we use some superimposed sin signals.
 signal <- ts_sin_superpos
 
@@ -78,12 +78,11 @@ output <-
     sigma = 5
   )
 
-# In this case the result is a matrix,
-# which can be used for further processing.
+# The result is a numeric matrix
 dim(output)
 ```
 
-Conversion functions to a meaningful data frame is also provided:
+A conversion functions to a data frame is also provided:
 
 ```{r example_df}
 head(as.data.frame(output), 10)
diff --git a/README.md b/README.md
index ae619cc..d503c26 100644
--- a/README.md
+++ b/README.md
@@ -76,7 +76,7 @@ continuous wavelet transform and plot the result.
 ``` r
 library(fcwtr)
 
-# You are given some signal encoded in a numeric vector.
+# A signal encoded in a numeric vector.
 # In this example we use some superimposed sin signals.
 signal <- ts_sin_superpos
 
@@ -90,13 +90,12 @@ output <-
     sigma = 5
   )
 
-# In this case the result is a matrix,
-# which can be used for further processing.
+# The result is a numeric matrix
 dim(output)
 #> [1] 6000  200
 ```
 
-Conversion functions to a meaningful data frame is also provided:
+A conversion functions to a data frame is also provided:
 
 ``` r
 head(as.data.frame(output), 10)