Merge pull request #231 from hendersontrent/trent-dev

additional vignette notes
hendersontrent · Feb 6, 2023 · 31b31fa · 31b31fa
2 parents 174d1a9 + 1a6242a
commit 31b31fa
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 11 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -2,7 +2,7 @@ Package: theft
 Type: Package
 Title: Tools for Handling Extraction of Features from Time Series
 Version: 0.4.2.2
-Date: 2023-02-02
+Date: 2023-02-06
 Authors@R: c(
   person("Trent", "Henderson", email = "then6675@uni.sydney.edu.au", role = c("cre", "aut")),
   person("Annie", "Bryant", role = "ctb", comment = "Balanced classification accuracy")

diff --git a/docs/articles/theft.html b/docs/articles/theft.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -3,7 +3,7 @@ pkgdown: 2.0.6
 pkgdown_sha: ~
 articles:
   theft: theft.html
-last_built: 2023-02-02T06:12Z
+last_built: 2023-02-06T02:05Z
 urls:
   reference: https://hendersontrent.github.io/theft/reference
   article: https://hendersontrent.github.io/theft/articles

diff --git a/docs/search.json b/docs/search.json
diff --git a/vignettes/theft.Rmd b/vignettes/theft.Rmd
@@ -78,12 +78,14 @@ feature_matrix <- calculate_features(data = simData,
                                      seed = 123)
 ```
 
-Note that if you want to use any of the Python-based packages, you must first tell R (prior to running `calculate_features`) which Python and virtual environment on your computer contains the installed libraries. This can be done via the `init_theft` function, which has two arguments:
+Note that if you want to use any of the Python-based packages, you must first tell R (prior to running `calculate_features`) which Python and/or virtual environment on your computer contains the installed libraries. This can be done in `theft` via the `init_theft` function, which has two arguments:
 
 1. `python_path` --- string specifying the filepath to the version of Python you wish to use
-1. `venv_path` --- string specifying the filepath to the Python virtual environment where `tsfresh`, `TSFEL`, and/or `Kats` are installed
+2. `venv_path` --- string specifying the filepath to the Python virtual environment where `tsfresh`, `TSFEL`, and/or `Kats` are installed
 
-**NOTE: You only need to call ** `init_theft` **once per session.**
+However, you do not necessarily have to use this convenience function. If you have another method for pointing R to the correct Python (such as `reticulate` or `findpython`), you can use those in your workflow instead.
+
+**NOTE: You only need to call ** `init_theft` **or your other solution once per session.**
 
 A tidy dataframe of *most* of the included features and the set they correspond to is available in the dataframe `feature_list`: