---
title: "Data Science for Psychologists (ds4psy)"
output: rmarkdown::html_vignette
pdf_document:
         latex_engine: xelatex
vignette: >
  %\VignetteIndexEntry{ds4psy}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

```{r preamble_ds4psy, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)
```

<!-- ds4psy logo (on right): -->
<a href="https://bookdown.org/hneth/ds4psy/">
<img src = "./../inst/images/logo.png" alt = "ds4psy" width = "160px" align = "right" style = "width: 160px; float: right; border:11;"/>
</a>


**Welcome** to the R package **ds4psy** &mdash; a software companion to the book and course 
[Data Science for Psychologists](https://bookdown.org/hneth/ds4psy/).   

This R package provides datasets and functions used in the book and course. 
Its source code is hosted at <https://github.com/hneth/ds4psy>. 

The book and course introduce the principles and methods of data science for students of psychology and other biological or social sciences. 
The book is available at <https://bookdown.org/hneth/ds4psy/>. 


## The ds4psy book, course, and R package 

The **ds4psy** book and course provide an introduction to data science that is tailored to the needs of psychologists, but is also suitable for students of the humanities and other biological or social sciences. 
This audience typically has some knowledge of statistics, but rarely an idea how data is prepared and shaped to allow for statistical testing. 
By using various data types and working with many examples, we teach tools for transforming, summarizing, and visualizing data. By keeping our eyes open for the perils of misleading representations, the book fosters fundamental skills of data literacy and cultivates reproducible research practices that enable and precede any practical use of statistics. 

The R package **ds4psy** primarily provides datasets, but also functions for data generation and manipulation (e.g., of text and time data) and graphics that are used in the book and its exercises. All functions included in **ds4psy** are designed to be explicit and instructive, rather than efficient or elegant. 


## Installation

The current release of **ds4psy** is available from [CRAN](https://CRAN.R-project.org/) at <https://CRAN.R-project.org/package=ds4psy>:

```{r install_CRAN, echo = TRUE, eval = FALSE}
install.packages('ds4psy')  # install ds4psy from CRAN client
library('ds4psy')           # load to use the package
```

The current development version can be installed from its [GitHub](https://github.com) repository at <https://github.com/hneth/ds4psy/>: 

```{r install_github, echo = TRUE, eval = FALSE}
# install.packages('devtools')  # (if not installed yet)
devtools::install_github('hneth/ds4psy')
library('ds4psy')  # load to use the package
```


## Resources

This package and the corresponding book are still being developed and are updated as new materials become available.  

- A current version of the book is available at <https://bookdown.org/hneth/ds4psy/>.  

- The current R package is available at <https://CRAN.R-project.org/package=ds4psy>.  

- For source versions, there are two GitHub repositories to be distinguished:  

    - The repository for the [ds4psy book](https://bookdown.org/hneth/ds4psy/) is <https://github.com/hneth/ds4psy> (with an additional suffix `_book`). 

    - The repository for the [ds4psy package](https://github.com/hneth/ds4psy/) is <https://github.com/hneth/ds4psy>.  

<!-- - The current course syllabus is available at <http://rpository.com/ds4psy/>.    -->


## About

If you find these materials useful, or want to adopt or alter them for your purposes, please [let me know](https://www.spds.uni-konstanz.de/en/people). 


### Citation

To cite **ds4psy** in derivations and publications, please use:

- Neth, H. (2023). ds4psy: Data Science for Psychologists.  
Social Psychology and Decision Sciences, University of Konstanz, Germany.  
Textbook and R package (version 1.0.0, September 15, 2023).  
Retrieved from <https://bookdown.org/hneth/ds4psy/>.  
[https://doi.org/10.5281/zenodo.7229812](https://doi.org/10.5281/zenodo.7229812)  


<!-- BibTeX reference: -->

A **BibTeX** entry for LaTeX users is: 

```{r pkg-citation, echo = TRUE, eval = FALSE, comment = "", highlight = FALSE}
@Manual{ds4psy,
  title = {ds4psy: Data Science for Psychologists},
  author = {Hansjörg Neth},
  year = {2023},
  organization = {Social Psychology and Decision Sciences, University of Konstanz},
  address = {Konstanz, Germany},
  note = {R package (version 1.0.0, September 15, 2023); Textbook at <https://bookdown.org/hneth/ds4psy/>.},
  url = {https://CRAN.R-project.org/package=ds4psy},
  doi = {10.5281/zenodo.7229812}
}
```


### License

<!-- (a) Use online image: -->

<!-- <a rel="license" href="https://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a> -->

<!-- (b) Use local image: -->

<a rel="license" href="https://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src = "./../inst/images/CC_BY_NC_SA.png" /></a>


<!-- License text:  -->

<span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">**Data science for psychologists** (**ds4psy**)</span> by <a xmlns:cc="https://creativecommons.org/ns#" href="https://neth.de" property="cc:attributionName" rel="cc:attributionURL">Hansjörg Neth</a> is licensed under a <a rel="license" href="https://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>. 


<!-- Update: -->

[Updated `r format(Sys.time(), "%Y-%m-%d")` by [hn](https://neth.de).]  

<!-- eof. -->