More prose

coatless-rpkg · Sep 14, 2024 · 80daaa0 · 80daaa0
1 parent 863861d
commit 80daaa0
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -73,7 +73,9 @@ summary(r_logo_image_data)
 
 ### Applying the Surreal Method
 
-Now, let's apply the surreal method to the R logo data to hide it in a dataset:
+Now, let's apply the surreal method to the R logo data to hide it in a dataset.
+We'll want to set a seed for reproducibility purposes since the algorithm
+relies on an optimization routine:
 
 ```{r}
 #| label: apply-surreal-method
@@ -102,7 +104,7 @@ plot(model$fitted, model$resid, pch = 16,
 ```
 
 The residual plot reveals the original R logo with a slight border. This
-border is automatically added to within the surreal method to enhance the
+border is automatically added inside the surreal method to enhance the
 recovery of the hidden image in the residual plot.
 
 ## Hide Your Own Message

diff --git a/README.md b/README.md
@@ -73,7 +73,8 @@ summary(r_logo_image_data)
 ### Applying the Surreal Method
 
 Now, let’s apply the surreal method to the R logo data to hide it in a
-dataset:
+dataset. We’ll want to set a seed for reproducibility purposes since the
+algorithm relies on an optimization routine:
 
 ``` r
 set.seed(114)
@@ -105,8 +106,8 @@ plot(model$fitted, model$resid, pch = 16,
 <img src="man/figures/README-surreal-method-residual-plot-1.png" width="100%" />
 
 The residual plot reveals the original R logo with a slight border. This
-border is automatically added to within the surreal method to enhance
-the recovery of the hidden image in the residual plot.
+border is automatically added inside the surreal method to enhance the
+recovery of the hidden image in the residual plot.
 
 ## Hide Your Own Message