DOC update readme

doehm · Jun 20, 2023 · 39eba9b · 39eba9b
1 parent ab2fb2f
commit 39eba9b
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 41 deletions.
diff --git a/R/helpers.R b/R/helpers.R
@@ -54,7 +54,7 @@ get_castaway_image <- function(castaway_ids, version_season) {
 #' if(interactive()) {
 #'
 #'   # launch app
-#'   launch_confessional_app()
+#'   # launch_confessional_app()
 #'
 #' }
 #'

diff --git a/README.Rmd b/README.Rmd
@@ -47,11 +47,11 @@ version <- str_replace(readLines("DESCRIPTION")[4], 'Version: ', 'v')
 
 `r max_seasons` seasons. `r n_people` people. 1 package!
 
-survivoR is a collection of data sets detailing events across `r max_seasons` seasons of Survivor US, Survivor Australia, Survivor South Africa and Survivor New Zealand. It includes castaway information, vote history, immunity and reward challenge winners, jury votes, advantage details and heaps more!
+survivoR is a collection of data sets detailing events across `r max_seasons` seasons of Survivor US, Australia, South Africa, New Zealand and UK. It includes castaway information, vote history, immunity and reward challenge winners, jury votes, advantage details and a lot more.
 
 # Installation
 
-Now on CRAN (v2.08) or Git (`r version`).
+Now on CRAN (v2.1.0) or Git (`r version`).
 
 If Git > CRAN I'd suggest install from Git. We are constantly improving the data sets so the github version is likely to be slightly improved.
 
@@ -63,28 +63,31 @@ install.packages("survivoR")
 devtools::install_github("doehm/survivoR")
 ```
 
-# News: survivoR 2.0.8
+# News: survivoR 2.1.0
 
-* Adding complete AU08 data
-* New features
-    * `final_n` on `boot_mapping`
-    * `n_cast` on `season_summary`
-    * `index_count` and `index_time` on `confessionals`
-* New `challenge_id` on `challenge_results`
+* Adding data for US44, UK01 and NZ02
+* Confessional timing app built with R Shiny (see below)
+* Confessional times for US44 and UK01
+* `result_number` on castaways
+* New features on `castaway_details`
+    * `lgbt`+ flag
+    * `three_words` – the answer to the question “Three words to describe you”.
+    * `hobbies`
+    * `pet_peeves`
 
 # Confessionals
 
 ### Confessionals repo
 
-The following link takes you to a repository of complete confessional tables, inlcuding counts and confessional timing for a few seasons.
+The following link takes you to a repository of complete <a href='http://gradientdescending.com/survivor/tables/confessionals.html'>confessional tables</a>, inlcuding counts and confessional timing for a few seasons.
 
-<a href='http://gradientdescending.com/survivor/tables/confessionals.html'><img src='http://gradientdescending.com/survivor/tables/confessionals/US/43/confessionals.png' align = 'center' height='50' width='auto'>&nbsp;Confessional tables</a>
+<a href='http://gradientdescending.com/survivor/tables/confessionals.html'><img src='http://gradientdescending.com/survivor/tables/confessionals/US/43/confessionals.png' align = 'center' height='400' width='auto'></a>
 
 Confessional counts from [myself](https://twitter.com/danoehm), [Carly Levitz](https://twitter.com/carlylevitz), [Sam](https://twitter.com/survivorfansam), Grace.
 
 ### Confessional timing
 
-In cluded in the package is a confessional timing app to record the length of confessionals while watching the episode. 
+Included in the package is a confessional timing app to record the length of confessionals while watching the episode. 
 
 To launch the app, first install the package and run,
 
@@ -93,7 +96,7 @@ library(survivoR)
 launch_confessional_app()
 ```
 
-<img src='dev/images/conf-app-gif.gif'>
+<a href='https://github.com/doehm/survivoR/tree/master/inst'><img src='dev/images/conf-app-gif.gif'></a>
 
 More info [here](https://github.com/doehm/survivoR/tree/master/inst).
 

diff --git a/README.md b/README.md
@@ -6,14 +6,13 @@
 64 seasons. 1011 people. 1 package!
 
 survivoR is a collection of data sets detailing events across 64 seasons
-of Survivor US, Survivor Australia, Survivor South Africa and Survivor
-New Zealand. It includes castaway information, vote history, immunity
-and reward challenge winners, jury votes, advantage details and heaps
-more!
+of Survivor US, Australia, South Africa, New Zealand and UK. It includes
+castaway information, vote history, immunity and reward challenge
+winners, jury votes, advantage details and a lot more.
 
 # Installation
 
-Now on CRAN (v2.08) or Git (v2.1).
+Now on CRAN (v2.1.0) or Git (v2.1.0).
 
 If Git \> CRAN I’d suggest install from Git. We are constantly improving
 the data sets so the github version is likely to be slightly improved.
@@ -26,32 +25,36 @@ install.packages("survivoR")
 devtools::install_github("doehm/survivoR")
 ```
 
-# News: survivoR 2.0.8
+# News: survivoR 2.1.0
 
-- Adding complete AU08 data
-- New features
-  - `final_n` on `boot_mapping`
-  - `n_cast` on `season_summary`
-  - `index_count` and `index_time` on `confessionals`
-- New `challenge_id` on `challenge_results`
+- Adding data for US44, UK01 and NZ02
+- Confessional timing app built with R Shiny (see below)
+- Confessional times for US44 and UK01
+- `result_number` on castaways
+- New features on `castaway_details`
+  - `lgbt`+ flag
+  - `three_words` – the answer to the question “Three words to describe
+    you”.
+  - `hobbies`
+  - `pet_peeves`
 
 # Confessionals
 
 ### Confessionals repo
 
-The following link takes you to a repository of complete confessional
-tables, inlcuding counts and confessional timing for a few seasons.
+The following link takes you to a repository of complete
+<a href='http://gradientdescending.com/survivor/tables/confessionals.html'>confessional
+tables</a>, inlcuding counts and confessional timing for a few seasons.
 
-<a href='http://gradientdescending.com/survivor/tables/confessionals.html'><img src='http://gradientdescending.com/survivor/tables/confessionals/US/43/confessionals.png' align = 'center' height='50' width='auto'> Confessional
-tables</a>
+<a href='http://gradientdescending.com/survivor/tables/confessionals.html'><img src='http://gradientdescending.com/survivor/tables/confessionals/US/43/confessionals.png' align = 'center' height='400' width='auto'></a>
 
 Confessional counts from [myself](https://twitter.com/danoehm), [Carly
 Levitz](https://twitter.com/carlylevitz),
 [Sam](https://twitter.com/survivorfansam), Grace.
 
 ### Confessional timing
 
-In cluded in the package is a confessional timing app to record the
+Included in the package is a confessional timing app to record the
 length of confessionals while watching the episode.
 
 To launch the app, first install the package and run,
@@ -61,7 +64,7 @@ library(survivoR)
 launch_confessional_app()
 ```
 
-<img src='dev/images/conf-app-gif.gif'>
+<a href='https://github.com/doehm/survivoR/tree/master/inst'><img src='dev/images/conf-app-gif.gif'></a>
 
 More info [here](https://github.com/doehm/survivoR/tree/master/inst).
 

diff --git a/inst/readme.html b/inst/readme.html
diff --git a/inst/readme.md b/inst/readme.md
@@ -30,9 +30,8 @@ It's better to watch the epiosde in one sitting and either rewatch or make minor
 
 ## A few things to note
 
--   When selecting a season and episode for the first time the images may need to be downloaded first. It will look like it is hanging but it is just downloading. Shouldn't take any more than 10 secs.
--   Every time a start or stop button is pressed it writes a time stamp to a file. At first it will write a file to 'Staging', a sub-folder from the default path.
+-   Every time a start or stop button is pressed it writes a time stamp to a file if `write = TRUE`. At first it will write a file to 'Staging', a sub-folder from the default path.
 -   Notes is just a free text field where you can make notes about the episode or things to correct / check after the episode airs. For example maybe you accidentally hit start on the wrong person. Note down the id and delete it manually in the csv after the episode airs.
 -   Notes when saved are in a sub-folder 'Notes'.
 
-<center><img src='www/conf-timing.png'/></center>
+<center><img src='../dev/images/conf-app-gif.gif'/></center>