From a2eff5045f655b639ad76e5695af1c8d8b447598 Mon Sep 17 00:00:00 2001 From: Ghozayel Elotteebi <67930059+Ghozayel@users.noreply.github.com> Date: Sun, 2 Oct 2022 08:26:40 +0100 Subject: [PATCH] Update README.md --- README.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 37200d0..ee2e523 100644 --- a/README.md +++ b/README.md @@ -5,25 +5,30 @@ [![DOI](https://zenodo.org/badge/525854071.svg)](https://zenodo.org/badge/latestdoi/525854071) -The goal of [Lextale package](https://ghozayel.github.io/Lextale/) is to calculates the [%correctAV scoring](https://www.lextale.com/scoring.html) for the English and German versions [LexTALE-test](https://www.lextale.com) if administered using implementations that do not end with participants' score on the screen, e.g. online surveys. For more info about the test, see [Lemhöfer & Broersma, 2012](https://www.lextale.com/pdf/Lemhofer_Broersma_2012.pdf). +The goal of [Lextale package](https://ghozayel.github.io/Lextale/) is to mark and calculates the [%correctAV scoring](https://www.lextale.com/scoring.html) for the English, German and Dutch versions [LexTALE-test](https://www.lextale.com) if administered using implementations that do not end with participants' score on the screen, e.g. online surveys. For more info about the test, see [Lemhöfer & Broersma, 2012](https://www.lextale.com/pdf/Lemhofer_Broersma_2012.pdf). ## Functions and Arguments ``` r lex() ``` -The argument for this function takes a dataframe which must inclue two variables(columns): -- ID: each ID must have 60 entries, e.g. ID *1987* repeated 60 times, with up to 10 IDs per time (=600 rows). -- answer: a variable of 0/1, of no more than 600 rows. +This function mark and calculates the lextale score for the English and German versions of the test. Its argument takes a dataframe which must inclue two variables(columns): +- ID: each ID must have 60 entries, e.g. ID *1987* repeated 60 times, with 40 IDs per time (=2400 rows). +- answer: a variable of 0/1, with 2400 rows. *Please note both columns names are case-sensitive. -Using this function can return the scores of up to 10 participants in one lex-click! -Future work on the function will be on accepting Yes/No in the argument.* +Using this function returns the scores of 40 participants in one lex-click! +Future work will be on accepting and open number of scores, and on accepting Yes/No in the argument.* + +``` r +lex.dutch() +``` +This function mark and calculates the lextale score for the Dutch version of the test. *Not yet live, but coming soon!* ``` r CEF() ``` -This function categorises the lexTALE-scores into three CEF levels. *Not yet live, but coming soon!* +This function categorises the English lexTALE-scores into three CEF levels. *Not yet live, but coming soon!* ## Installation @@ -41,8 +46,8 @@ This is a basic example which shows you how to use the *lex()* function to calcu ``` r #The first 3 lines below generate fake data for the purpose of testing the lex() function: -answer <- sample(c(0/1), replace = TRUE, 600) #generate 600 random binary responses -ID <- gl(10, 60) #generate 10 ids +answer <- sample(c(0/1), replace = TRUE, 2400) #generate 600 random binary responses +ID <- gl(40, 60) #generate 10 ids data <- cbind(ID, answer) #combine the two columns above into one data #The following line run the lextale test: Lextale::lex(data)