From c17af5804240f517a516a54d4852757e49751822 Mon Sep 17 00:00:00 2001 From: Josh Fogg Date: Tue, 24 Aug 2021 11:53:45 +0100 Subject: [PATCH] Minor doc corrections --- CITATION.cff | 26 ++++++++++++++++++++++++++ README.md | 10 ++++++---- app.R | 2 +- 3 files changed, 33 insertions(+), 5 deletions(-) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..c4af490 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,26 @@ +# YAML 1.2 +--- +abstract: "A Shiny App built with R to demonstrate the building of decision trees for email spam filtering systems." +authors: + - + affiliation: "University of Edinburgh" + family-names: Fogg + given-names: Josh + - + affiliation: "University of Edinburgh" + family-names: Deutsch + given-names: Isabella +cff-version: "1.1.0" +date-released: 2020-06-17 +identifiers: +keywords: + - "machine-learning" + - r + - shiny + - "decision-trees" + - "spam-filtering" +license: MIT +message: "If you use this software, please cite it using these metadata." +repository-code: "https://github.com/Foggalong/shiny-decision-trees" +title: "Decision Tree Shiny App" +... \ No newline at end of file diff --git a/README.md b/README.md index dd45972..b072ac9 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # Decision Tree Shiny App -In summer 2020 [Isabella Deutsch](https://isabelladeutsch.com/) and [myself](https://www.maths.ed.ac.uk/~jfogg/) gave a mini lecture on machine learning as part of a [Sutton Trust](https://www.suttontrust.com/) summer school. One of the questions on our problem sheet asked students to explore building a decision tree for spam filtering using this Shiny App. For the duration of the summer school the app is [deployed on ShinyApps.io](https://foggalong.shinyapps.io/sutton-dt/). +[Isabella Deutsch](https://isabelladeutsch.com/) and [myself](https://www.maths.ed.ac.uk/~jfogg/) gave a mini lecture and tutorial on machine learning as part of the [Sutton Trust](https://www.suttontrust.com/)'s 2019 and 2020 summer schools. One question on our problem sheet asked students to explore building a decision tree for spam filtering using this Shiny App. The app is currently [deployed on ShinyApps.io](https://foggalong.shinyapps.io/sutton-dt/). ## Background + The webapp is written in the [R programming language](https://en.wikipedia.org/wiki/R_(programming_language)) using a toolkit called [Shiny](https://shiny.rstudio.com/) to create the interface. R itself is a reasonably mature language (26 years old at time of writing) well favoured by statisticians across academia and industry for the depth of the tools it provides \[1\]\[2\]. For example, a function called [`rpart`](https://www.rdocumentation.org/packages/rpart/versions/4.1-15/topics/rpart) does a considerably portion of the heavy lifting here in calculating the decision tree. If you do a math degree at University you will no doubt come across R in your statistics courses. @@ -10,7 +11,8 @@ R itself is a reasonably mature language (26 years old at time of writing) well Shiny by comparison is relatively new; development started about 8 years ago but it's really come into its own over the last couple of years. Creating intuitive, interactive webapps is normally a tricky business and it's an area of development in its own right. Part of what makes Shiny so appealing is that it strips UI back to a basic selection of customisable widgets, all handled in R. This makes it incredibly easy for statisticians, most of whom have no background in UI or web development, to create and deploy nice looking applications for others to explore their work. ## Data Set -The app uses the [Spambase Data Set](https://archive.ics.uci.edu/ml/datasets/Spambase) from the UCI Machine Learning Repository \[1\]. A partitioned version of this dataset is included with this repository, but in summary each row is a different and the columns are as follows: + +The app uses the [Spambase Data Set](https://archive.ics.uci.edu/ml/datasets/Spambase) from the UCI Machine Learning Repository \[3\]. A partitioned version of this dataset is included with this repository, but in summary each row is a different and the columns are as follows: - 1 to 48 are "word" (i.e. a sequence of on-whitespace characters) frequencies as percentages of the email body text, - 49 to 54 are character frequencies as percentages of the email body text, @@ -21,12 +23,12 @@ The app uses the [Spambase Data Set](https://archive.ics.uci.edu/ml/datasets/Spa There are 4,601 emails of which 1,813 are spam and 2,788 are not. As mentioned we've randomly partitioned this into two files, [one for training](https://github.com/Foggalong/shiny-decision-trees/blob/master/training-data.csv) (70% of the entries) and [one for testing](https://github.com/Foggalong/shiny-decision-trees/blob/master/test-data.csv) (the remaining 30% of entries). - ## License -The `app.R` file is released under an MIT License and provided without warranty. +The `app.R` file is released under an MIT License and provided without warranty. ## References + - [\[1\]](https://socialsciences.mcmaster.ca/jfox/Teaching-with-R.pdf) Fox, John & Andersen, Robert (2005), "Using the R Statistical Computing Environment to Teach Social Statistics Courses". Department of Sociology, McMaster University. - [\[2\]](https://www.nytimes.com/2009/01/07/technology/business-computing/07program.html) Vance, Ashlee (2009). "Data Analysts Captivated by R's Power". New York Times. - [\[3\]](http://archive.ics.uci.edu/ml): Dua, Dheeru and Graff, Casey (2017), UCI Machine Learning Repository, University of California, Irvine, School of Information and Computer Sciences. diff --git a/app.R b/app.R index 4edada3..227c350 100644 --- a/app.R +++ b/app.R @@ -282,7 +282,7 @@ ui = fluidPage( "and on the worksheet so check there if you're not sure what a", "particular term or symbol means. If you are having any issues", tags$a( - href = "mailto:j.fogg@sms.ed.ac.uk", + href = "mailto:j.fogg@ed.ac.uk", "drop us an email" ), "and we'll get back to you as soon as possible.",