Skip to content

Commit

Permalink
Added details so we can go public! (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
fontikar authored Jun 14, 2024
1 parent ed2cf83 commit d542557
Showing 1 changed file with 32 additions and 5 deletions.
37 changes: 32 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,46 @@
# R for Psychology
# R for Psychology Quarto book

<!-- badges: start -->
This book is written in mind for someone working in Psychology and is venturing into R with little to no experience. Research data in Psychology is unique in that it is collected in formats that are human-readable but not exactly R-readable. Data wrangling conventions will often vary depending on research question and therefore by which data is collected. In "R for Psychology", we have compiled a series of real-world examples from different sub-disciplines and will walk through the process of wrangling, summary, analyses and visualisations

<!-- badges: end -->
The book can be assessed via https://unsw-edu-au.github.io/r4psych/

This book is written in mind for someone working in Psychology and is venturing into R with little to no experience. Research data in Psychology is unique in that it is collected in formats that are human-readable but not exactly R-readable. Data wrangling conventions will often vary depending on research question and therefore by which data is collected. In "R for Psychology", we have compiled a series of real-world examples from different sub-disciplines and will walk through the process of wrangling, summary, analyses and visualisations
This book is licensed under a [Creative Commons Attribution-NonCommercial 4.0 International License](https://creativecommons.org/licenses/by-nc/4.0/)

## Authors

The first draft of this book was created by [Fonti Kar](https://github.com/fontikar), [Jenny Richmond](https://www.unsw.edu.au/staff/jenny-richmond) and [Lisa Williams](https://www.unsw.edu.au/staff/lisa-williams)

## How to contribute

This book is built using Quarto and hosted via GitHub Pages. It is a living resource, we welcome any contributions from the Psychology community that would improve the quality of this book. The authors are the current maintainers and will be happy to review contributions that adhere to our contributing guidelines.

There are many ways to contribute:

### Render the book locally
- Fixing grammar and typos
- Clarification or expanding on existing content
- Contribute real-world data in worked examples
- Authoring an entire chapter

Take a look at our [Contributing Guideline](https://unsw-edu-au.github.io/r4psych/contributing.html) to see how you can help!

## Questions and feedback

If you would have any questions or discuss ideas or provide to feedback, Please contact [Fonti](mailto:[email protected]) or submit a [Github Issue ](https://github.com/unsw-edu-au/r4psych/issues)

## Acknowledgements
This book was created on the unceded territory of the Bedegal people who are the Traditional custodians of the lands where the Kensington campus is located.

The first version of this book was funded by the [UNSW Research Infrastructure Scheme](https://research.unsw.edu.au/research-infrastructure).

## Render the book locally

1. Install Quarto using [these instructions](https://quarto.org/docs/get-started/)
2. Clone this repository to your local computer
3. Open the r4psych.Rproj file using RStudio
4. Click on any `.qmd` files and click on `Render`.

Alternatively,

4. Click on there 'Terminal' pane and type `quarto render` and hit enter
5. Once the book has been rendered and the terminal is free, type `quarto preview` and hit enter

Expand Down

0 comments on commit d542557

Please sign in to comment.