Skip to content

Commit 7c6059f

Browse files
committed
Update references
Fix for #14 .
1 parent 76d61f6 commit 7c6059f

File tree

4 files changed

+22
-14
lines changed

4 files changed

+22
-14
lines changed

README.Rmd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,17 +81,17 @@ vignette('PupillometryR')
8181
## Getting help
8282

8383
Please use the issues tab (https://github.com/samhforbes/PupillometryR/issues) to file any bugs or suggestions.
84-
For general pupillometry information, I recommend [Sylvain's website](https://oraprdnt.uqtr.uquebec.ca/pls/public/gscw031?owa_no_site=314&owa_no_fiche=3&owa_bottin=https://oraprdnt.uqtr.uquebec.ca/pls/public/gscw031?owa_no_site=314&owa_no_fiche=3&owa_bottin=), for reading about using GAMs in pupillometry [this paper by van Rij et al. is excellent](https://journals.sagepub.com/doi/10.1177/2331216519832483), for general GAMs knowledge I recommend [this tutorial by Michael Clark](https://m-clark.github.io/generalized-additive-models/case_for_gam.html) as well as the mgcv documentation, and for general FDA information [this website is helpful](https://www.psych.mcgill.ca/misc/fda/resources.html), along with the Ramsey and Silverman book. Additionally, check out the raincloud plots paper by Allen et al., which is used for some of the in-built plotting in this package [here](http://doi.org/10.1044/1092-4388(2010/09-0205)).
84+
For general pupillometry information, I recommend [Sylvain's website](https://oraprdnt.uqtr.uquebec.ca/pls/public/gscw031?owa_no_site=314&owa_no_fiche=3&owa_bottin=https://oraprdnt.uqtr.uquebec.ca/pls/public/gscw031?owa_no_site=314&owa_no_fiche=3&owa_bottin=), [as well as Jackson and Sirois (2009)](http://doi.org/10.1111/j.1467-7687.2008.00805.x). For reading about using GAMs in pupillometry [this paper by van Rij et al. is excellent](https://journals.sagepub.com/doi/10.1177/2331216519832483), for general GAMs knowledge I recommend [this tutorial by Michael Clark](https://m-clark.github.io/generalized-additive-models/case_for_gam.html) as well as the mgcv documentation, and for general FDA information [this website is helpful](http://www.psych.mcgill.ca/misc/fda/resources.html), along with the Ramsay and Silverman book (1997). Additionally, check out the [raincloud plots paper by Allen et al.](https://wellcomeopenresearch.org/articles/4-63#:~:text=In%20essence%2C%20raincloud%20plots%20combine,error%2C%20such%20as%20a%20boxplot.), which is used for some of the in-built plotting in this package.
8585

8686
## Acknowledgements
8787

88-
This package has had suggestions, encouragement, and help from a number of people, but I wish to especially highlight Sylvain Sirois and Mihaela Duta, whose input has been instrumental. I'd also like to thank Jacolien van Rij for her input with the GAMMs modelling portion of this tutorial.
88+
This package has had suggestions, encouragement, and help from a number of people, but I wish to especially highlight Sylvain Sirois and Mihaela Duta, whose input has been instrumental. I'd also like to thank Jacolien van Rij for her input with the GAMs modelling portion of this tutorial.
8989

9090
## References
9191

9292
[1] Jackson, I., & Sirois, S. (2009). Infant cognition: Going full factorial with pupil dilation. *Developmental Science*, 12(4), 670-679. http://doi.org/10.1111/j.1467-7687.2008.00805.x
9393

94-
[2] Allen, M., Poggiali, D., Whitaker, K., Marshall, T. R., & Kievit, R. (2018). Raincloud plots: a multi-platform tool for robust data visualization. *Wellcome Open Research*, 4, 63.
94+
[2] Allen, M., Poggiali, D., Whitaker, K., Marshall, T. R., & Kievit, R. (2018). Raincloud plots: a multi-platform tool for robust data visualization. *Wellcome Open Research*, 4, 1-41.
9595
doi:10.12688/wellcomeopenres.15191.1
9696

9797
[3] Ramsay, J.O., & Silverman, B.W. (1997). *Functional data analysis*. New York: Springer-Verlag.

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -98,25 +98,25 @@ Please use the issues tab
9898
or suggestions. For general pupillometry information, I recommend
9999
[Sylvain’s
100100
website](https://oraprdnt.uqtr.uquebec.ca/pls/public/gscw031?owa_no_site=314&owa_no_fiche=3&owa_bottin=https://oraprdnt.uqtr.uquebec.ca/pls/public/gscw031?owa_no_site=314&owa_no_fiche=3&owa_bottin=),
101-
for reading about using GAMs in pupillometry [this paper by van Rij et
102-
al. is
101+
[as well as Jackson and Sirois
102+
(2009)](http://doi.org/10.1111/j.1467-7687.2008.00805.x). For reading
103+
about using GAMs in pupillometry [this paper by van Rij et al. is
103104
excellent](https://journals.sagepub.com/doi/10.1177/2331216519832483),
104105
for general GAMs knowledge I recommend [this tutorial by Michael
105106
Clark](https://m-clark.github.io/generalized-additive-models/case_for_gam.html)
106107
as well as the mgcv documentation, and for general FDA information [this
107-
website is
108-
helpful](https://www.psych.mcgill.ca/misc/fda/resources.html), along
109-
with the Ramsey and Silverman book. Additionally, check out the
110-
raincloud plots paper by Allen et al., which is used for some of the
111-
in-built plotting in this package
112-
[here](http://doi.org/10.1044/1092-4388\(2010/09-0205\)).
108+
website is helpful](http://www.psych.mcgill.ca/misc/fda/resources.html),
109+
along with the Ramsay and Silverman book (1997). Additionally, check out
110+
the [raincloud plots paper by Allen et
111+
al.](https://wellcomeopenresearch.org/articles/4-63#:~:text=In%20essence%2C%20raincloud%20plots%20combine,error%2C%20such%20as%20a%20boxplot.),
112+
which is used for some of the in-built plotting in this package.
113113

114114
## Acknowledgements
115115

116116
This package has had suggestions, encouragement, and help from a number
117117
of people, but I wish to especially highlight Sylvain Sirois and Mihaela
118118
Duta, whose input has been instrumental. I’d also like to thank Jacolien
119-
van Rij for her input with the GAMMs modelling portion of this tutorial.
119+
van Rij for her input with the GAMs modelling portion of this tutorial.
120120

121121
## References
122122

@@ -126,7 +126,7 @@ factorial with pupil dilation. *Developmental Science*, 12(4), 670-679.
126126

127127
\[2\] Allen, M., Poggiali, D., Whitaker, K., Marshall, T. R., & Kievit,
128128
R. (2018). Raincloud plots: a multi-platform tool for robust data
129-
visualization. *Wellcome Open Research*, 4, 63.
129+
visualization. *Wellcome Open Research*, 4, 1-41.
130130
<doi:10.12688/wellcomeopenres.15191.1>
131131

132132
\[3\] Ramsay, J.O., & Silverman, B.W. (1997). *Functional data

paper/paper.bib

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,14 @@ @article{Mathot2018
3737
keywords = {Baseline correction, Pupil size, Pupillometry, Research methods}
3838
}
3939

40+
@misc{Ramsay2020,
41+
author = {Ramsay, J. O. and {Graves S.} and Hooker, G.},
42+
title = {{fda: Functional Data Analysis}},
43+
year = {2020}
44+
url = {https://CRAN.R-project.org/package=fda }
45+
}
46+
47+
4048
@article{Hershman2019,
4149
title = {{CHAP: Open-source software for processing and analyzing pupillometry data}},
4250
year = {2019},

paper/paper.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Thus PupillometryR aims to assist experimenters by providing a clear pipeline wh
3434

3535
![An example of a raincloud plot of pupil data in PupillometryR.](Raincloud.pdf)
3636

37-
`PupillometryR` extends a suggested pipeline for implementation of pupillometric studies [@Jackson2009], making heavy use of the `signal` package [@signal2014] for pre-processing of the pupil data. The in-built plotting functions, designed for ease of use, rely on `ggplot2` [@Wickham2016] for the data visualisation, and include raincloud plots [@Allen2019] as an in-built data visualisation option. For analysis several options are given, including the use of Generalised Additive Models which uses the `mgcv` package [@Wood2017], and Functional Data Analysis, which uses functions from the `fda` package [@Ramsay1997].
37+
`PupillometryR` extends a suggested pipeline for implementation of pupillometric studies [@Jackson2009], making heavy use of the `signal` package [@signal2014] for pre-processing of the pupil data. The in-built plotting functions, designed for ease of use, rely on `ggplot2` [@Wickham2016] for the data visualisation, and include raincloud plots [@Allen2019] as an in-built data visualisation option. For analysis several options are given, including the use of Generalised Additive Models which uses the `mgcv` package [@Wood2017], and Functional Data Analysis, which uses functions from the `fda` package [@Ramsay2020].
3838

3939
![An example of a functional t-test in PupillometryR.](FDA.pdf)
4040

0 commit comments

Comments
 (0)