Skip to content

Commit

Permalink
README: improve example comments
Browse files Browse the repository at this point in the history
  • Loading branch information
lschneiderbauer committed Jun 9, 2024
1 parent 15ff468 commit 411b081
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
7 changes: 3 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)
Expand Down
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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)
Expand Down

0 comments on commit 411b081

Please sign in to comment.