Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
James committed Aug 29, 2020
1 parent dfc5097 commit 28e05b3
Show file tree
Hide file tree
Showing 162 changed files with 22 additions and 34,452 deletions.
Binary file modified .DS_Store
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.

This file was deleted.

This file was deleted.

This file was deleted.

Binary file removed Data/ONZE_vowels_filtered_anon_extra.rds
Binary file not shown.
47 changes: 22 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,32 @@

Brand, J., Hay, J., Clark, L., Watson, K., & Sóskuthy, M. (submitted). Systematic co-variation of monophthongs across speakers of New Zealand English.

[![](https://img.shields.io/badge/GitHub-repo-blue?labelColor=lightgrey&logo=github)](https://github.com/jamesbrandscience/Covariation_monophthongs_NZE_2020)
[![](https://img.shields.io/badge/GitHub-repo-blue?labelColor=lightgrey&logo=github)](https://github.com/nzilbb/Covariation_monophthongs_NZE)
[![](https://tinyurl.com/osfshield1)](https://osf.io/q4j29/)
[![](https://img.shields.io/badge/Preprint-pdf-blue?labelColor=lightgrey&logo=Adobe-Acrobat-Reader)](https://jamesbrandscience.github.io/Covariation_monophthongs_NZE_2020/Write_up/Covariation_monophthongs_NZE_2020.pdf)
[![](https://img.shields.io/badge/Analysis-html-blue?labelColor=lightgrey&logo=RStudio&logoColor=GhostWhite)](https://jamesbrandscience.github.io/Covariation_monophthongs_NZE_2020/Analysis/Covariation_monophthongs_analysis.html)
[![](https://img.shields.io/badge/Preprint-pdf-blue?labelColor=lightgrey&logo=Adobe-Acrobat-Reader)](https://nzilbb.github.io/Covariation_monophthongs_NZE_2020/Write_up/Covariation_monophthongs_NZE_2020.pdf)
[![](https://img.shields.io/badge/Analysis-html-blue?labelColor=lightgrey&logo=RStudio&logoColor=GhostWhite)](https://nzilbb.github.io/Covariation_monophthongs_NZE/Covariation_monophthongs_analysis.html)
[![](https://img.shields.io/badge/Shiny-link-blue?labelColor=lightgrey&logo=RStudio&logoColor=GhostWhite)](https://nzilbb.shinyapps.io/Covariation_shiny/)

![](https://img.shields.io/github/last-commit/jamesbrandscience/Covariation_monophthongs_NZE_2020)
![](https://img.shields.io/github/downloads/jamesbrandscience/Covariation_monophthongs_NZE_2020/total.svg)
![](https://img.shields.io/github/last-commit/nzilbb/Covariation_monophthongs_NZE)
![](https://img.shields.io/github/downloads/nzilbb/Covariation_monophthongs_NZE/total.svg)

---

### Download

You can download this repository as a `.zip` file, with all the files described below (advised):

[![](https://img.shields.io/badge/download-.zip-brightgreen)](https://github.com/jamesbrandscience/Covariation_monophthongs_NZE_2020/archive/master.zip)
[![](https://img.shields.io/badge/download-.zip-brightgreen)](https://github.com/nzilbb/Covariation_monophthongs_NZE_2020/archive/master.zip)

Or you can clone this repository using your terminal/command prompt (if you are familiar with GitHub, advised):

```
git clone https://github.com/jamesbrandscience/Covariation_monophthongs_NZE_2020.git
git clone https://github.com/nzilbb/Covariation_monophthongs_NZE_2020.git
```

Or fork it on GitHub (if you are familiar with GitHub, advised:

[![GitHub forks](https://img.shields.io/github/forks/jamesbrandscience/Covariation_monophthongs_NZE_2020.svg?style=social&label=Fork&maxAge=2592000)](https://GitHub.com/jamesbrandscience/Covariation_monophthongs_NZE_2020/fork/)
[![GitHub forks](https://img.shields.io/github/forks/nzilbb/Covariation_monophthongs_NZE_2020.svg?style=social&label=Fork&maxAge=2592000)](https://GitHub.com/nzilbb/Covariation_monophthongs_NZE_2020/fork/)

You can also download individual files using the ![](https://tinyurl.com/yct7xbra) icon (this not advised as most files are dependent on other files to run correctly).

Expand All @@ -51,13 +51,13 @@ You are reading the `README.md` file.

### Analysis

- **Covariation_monophthongs_analysis.Rmd** [![](https://tinyurl.com/yct7xbra)](https://raw.githubusercontent.com/jamesbrandscience/Covariation_monophthongs_NZE_2020/master/Analysis/Covariation_monophthongs_analysis.Rmd)
- **Covariation_monophthongs_analysis.Rmd** [![](https://tinyurl.com/yct7xbra)](https://raw.githubusercontent.com/nzilbb/Covariation_monophthongs_NZE_2020/master/Analysis/Covariation_monophthongs_analysis.Rmd)

- R Markdown document containing all the code that is required to reproduce the analyses reported in the paper
- This file is to be used in RStudio
- It requires the `data` folder to work
- **Covariation_monophthongs_filtering_anon.html** [![](https://tinyurl.com/yct7xbra)](https://jamesbrandscience.github.io/Covariation_monophthongs_NZE_2020/Analysis/Covariation_monophthongs_analysis.html)

- **Covariation_monophthongs_filtering_anon.html** [![](https://tinyurl.com/yct7xbra)](https://nzilbb.github.io/Covariation_monophthongs_NZE_2020/Analysis/Covariation_monophthongs_analysis.html)

- HTML output of the data filtering file (`Covariation_monophthongs_filtering_anon.Rmd`)
- This is used as a web accessible version to show the workflow of the data filtering (accessible [[here]](LINK))
Expand All @@ -69,14 +69,14 @@ You are reading the `README.md` file.
- These are in `.png` format and are used as an external source for the images in the `.html` output
- Created to reduce the size of the `Covariation_monophthongs_analysis.html` file

- **Covariation_monophthongs_filtering_anon.Rmd** [![](https://tinyurl.com/yct7xbra)](https://raw.githubusercontent.com/jamesbrandscience/Covariation_monophthongs_NZE_2020/master/Analysis/Covariation_monophthongs_filtering_anon.Rmd)
- **Covariation_monophthongs_filtering_anon.Rmd** [![](https://tinyurl.com/yct7xbra)](https://raw.githubusercontent.com/nzilbb/Covariation_monophthongs_NZE_2020/master/Analysis/Covariation_monophthongs_filtering_anon.Rmd)

- R Markdown document containing all the code that was run during the filtering workflow reported in the paper
- This file is to be used in RStudio
- We do not provide the raw data for this file to run as it contains information about the speakers that we do not wish to make publicly available


- **Covariation_monophthongs_analysis.html** [![](https://tinyurl.com/yct7xbra)](https://jamesbrandscience.github.io/Covariation_monophthongs_NZE_2020/Analysis/Covariation_monophthongs_filtering.html)
- **Covariation_monophthongs_analysis.html** [![](https://tinyurl.com/yct7xbra)](https://nzilbb.github.io/Covariation_monophthongs_NZE_2020/Analysis/Covariation_monophthongs_filtering.html)

- HTML output of the main analysis file (`Covariation_monophthongs_analysis.Rmd`)
- This is used as a web accessible version of the analysis (accessible [[here]](LINK))
Expand All @@ -85,9 +85,9 @@ You are reading the `README.md` file.

- All data files required to run the main analysis file
- This contains
- The raw data file as a R data object `ONZE_vowels_filtered_anon.rds` [![](https://tinyurl.com/yct7xbra)](https://github.com/jamesbrandscience/Covariation_monophthongs_NZE_2020/raw/master/Analysis/Data/ONZE_vowels_filtered_anon.rds)
- The random intercepts for speaker from the GAMMs `gam_intercepts_tmp_new.csv` [![](https://tinyurl.com/yct7xbra)](https://raw.githubusercontent.com/jamesbrandscience/Covariation_monophthongs_NZE_2020/master/Analysis/Data/gam_intercepts_tmp_new.csv)
- The random intercepts for speaker from the lmers `lmer_intercepts.csv` [![](https://tinyurl.com/yct7xbra)](https://raw.githubusercontent.com/jamesbrandscience/Covariation_monophthongs_NZE_2020/master/Analysis/Data/lmer_intercepts.csv)
- The raw data file as a R data object `ONZE_vowels_filtered_anon.rds` [![](https://tinyurl.com/yct7xbra)](https://github.com/nzilbb/Covariation_monophthongs_NZE_2020/raw/master/Analysis/Data/ONZE_vowels_filtered_anon.rds)
- The random intercepts for speaker from the GAMMs `gam_intercepts_tmp_new.csv` [![](https://tinyurl.com/yct7xbra)](https://raw.githubusercontent.com/nzilbb/Covariation_monophthongs_NZE_2020/master/Analysis/Data/gam_intercepts_tmp_new.csv)
- The random intercepts for speaker from the lmers `lmer_intercepts.csv` [![](https://tinyurl.com/yct7xbra)](https://raw.githubusercontent.com/nzilbb/Covariation_monophthongs_NZE_2020/master/Analysis/Data/lmer_intercepts.csv)
- An additional folder `Models` containing pre-run GAMM outputs

- **Figures**
Expand All @@ -99,7 +99,7 @@ You are reading the `README.md` file.

- These are libraries used for the compilation of the `Covariation_monophthongs_analysis.html` file
- Created to reduce the file size

- **Covariation_shiny**

- All the files that run the shiny web app (accessible [[here]](https://nzilbb.shinyapps.io/Covariation_shiny/))
Expand All @@ -108,16 +108,16 @@ You are reading the `README.md` file.
- `ONZE_summary.rds` contains speaker summaries per vowel (mean F1/F2, demographics, PC scores) and PC vowel-formant loadings. This is used to generate the PC score and vowel space plots
- `mod_pred_data.rds` contains the model predictions from the year of birth GAMMs. This is used for the sound change exploration
- The `www` folder contains various images to customise the appearance of the app. There is also `about.md` and `more.md` that create the about and more sections
- The `rsconnect` folder is generated when deployed to shinyapps.io
- The `rsconnect` folder is generated when deployed to shinyapps.io

- You can also run the app locally using the following R code (note you need the `shiny` package installed in R, you can do this by `install.packages("shiny")`):

```
library(shiny)
runUrl( "https://jamesbrandscience.github.io/Covariation_monophthongs_NZE_2020/Analysis/Covariation_shiny.zip")
runUrl( "https://nzilbb.github.io/Covariation_monophthongs_NZE_2020/Analysis/Covariation_shiny.zip")
```

- **Analysis_reduced** [![](https://tinyurl.com/yct7xbra)](https://github.com/jamesbrandscience/Covariation_monophthongs_NZE_2020/raw/master/Analysis/Analysis_reduced.zip)
- **Analysis_reduced** [![](https://tinyurl.com/yct7xbra)](https://github.com/nzilbb/Covariation_monophthongs_NZE_2020/raw/master/Analysis/Analysis_reduced.zip)

- A slimline `.zip` folder for download purposes, it contains all the main analysis files

Expand All @@ -132,6 +132,3 @@ You are reading the `README.md` file.
- **references.bib**

- **Cover_letter_JPhon**



Loading

0 comments on commit 28e05b3

Please sign in to comment.