{"id":23922944,"url":"https://github.com/kalimu/limerick","last_synced_at":"2025-04-12T00:13:44.014Z","repository":{"id":89758913,"uuid":"64644697","full_name":"kalimu/LimeRick","owner":"kalimu","description":"Bridge between LimeSurvey and R (and Shiny)","archived":false,"fork":false,"pushed_at":"2017-03-29T09:54:57.000Z","size":61,"stargazers_count":29,"open_issues_count":5,"forks_count":9,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-12T00:13:36.793Z","etag":null,"topics":["limerick","limesurvey"],"latest_commit_sha":null,"homepage":"","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kalimu.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-08-01T07:14:32.000Z","updated_at":"2025-02-27T22:57:17.000Z","dependencies_parsed_at":null,"dependency_job_id":"5c29ce9a-a6e8-4144-8916-ea2cceb7afe9","html_url":"https://github.com/kalimu/LimeRick","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kalimu%2FLimeRick","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kalimu%2FLimeRick/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kalimu%2FLimeRick/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kalimu%2FLimeRick/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kalimu","download_url":"https://codeload.github.com/kalimu/LimeRick/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248497820,"owners_count":21113984,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["limerick","limesurvey"],"created_at":"2025-01-05T17:28:24.775Z","updated_at":"2025-04-12T00:13:44.004Z","avatar_url":"https://github.com/kalimu.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\noutput: github_document\n---\n \n\n\n\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, echo = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"README-\"\n)\n```\n\n\n```{r, echo = FALSE}\n# devtools::install_github(\"rmhogervorst/badgecreatr\")\n# badgecreatr::badgeplacer(status = \"wip\" , githubaccount = \"kalimu\",githubrepo = \"LimeRick\")\n#[![minimal R version](https://img.shields.io/badge/R\u003e=-3.3.1-6666ff.svg)](https://cran.r-project.org/)\n```\n\n \nLimeRick\n==========\n\n[![Project Status: active](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/)\n[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/LimeRick)](https://cran.r-project.org/package=LimeRick)\n [![rstudio mirror downloads](http://cranlogs.r-pkg.org/badges/LimeRick?)](https://github.com/metacran/cranlogs.app)\n\n\u003cstrong\u003eBridge between R and LimeSurvey\u003c/strong\u003e  \nby Kamil Wais, Ph. D. ([homepage / contact](http://www.wais.kamil.rzeszow.pl))\n \n \nThe package homepage:\n[http://www.wais.kamil.rzeszow.pl/LimeRick/](http://www.wais.kamil.rzeszow.pl/LimeRick/)\n\nThe LimeSurvey homepage:\n[http://limesurvey.org](http://limesurvey.org)\n\n\n## LimeRick: motivation \n\n* need for a bridge that \u003cspan style=\"font-weight: bold\"\u003econnects very closely\u003c/span\u003e two important open-sorce projects (R\u0026nbsp;and\u0026nbsp;LimeSurvey)\n* need for an \u003cspan style=\"font-weight: bold\"\u003eadvanced tool\u003c/span\u003e that allow for:\n    * \u003cspan style=\"font-weight: bold\"\u003equickly importing\u003c/span\u003e responses into R from active on-line surveys\n    * \u003cspan style=\"font-weight: bold\"\u003eautomatically accessing\u003c/span\u003e properties of survey and questions \n    * \u003cspan style=\"font-weight: bold\"\u003emontoring\u003c/span\u003e survey status and responses directly from R\n    * \u003cspan style=\"font-weight: bold\"\u003eadding new responses\u003c/span\u003e to a survey directly from R\n    * \u003cspan style=\"font-weight: bold\"\u003esimplifying workflow\u003c/span\u003e for reproducible analysis\u003cbr\u003e (by providing in advance structured data schema)\n    * developing \u003cspan style=\"font-weight: bold\"\u003edata products\u003c/span\u003e based on \u003cspan style=\"font-weight: bold\"\u003ereal-time\u003c/span\u003e declarative data collection\u003cbr\u003e (ex. continous on-line tracking studies)\n    * collecting meta-data of respondents interactions with on-line surveys \u003cbr\u003eon \u003cspan style=\"font-weight: bold\"\u003eunique low-granular level\u003c/span\u003e\n\n\n## LimeRick: tutorial\n\n### Installing developer version from GitHub\n\n```{r, echo=TRUE, eval=FALSE, cache=FALSE}\n# install.packages('devtools')\ndevtools::install_github(\"kalimu/LimeRick\")\n```\n\n### Loading the installed package\n\n```{r, echo=TRUE, eval=TRUE, cache=FALSE}\nlibrary(LimeRick)\n```\n\n### Configuring access to a survey\n\n```{r, echo=TRUE, eval=TRUE, cache=FALSE}\n# set link to the LimeSurvey API on the demo remote server\noptions(lsAPIurl = 'http://odgar.pl/survey/index.php/admin/remotecontrol')\n\n# set LimeSurvey user login data for survey testing purposes\noptions(lsUser = \"LimeRickDemo\")\noptions(lsPass = \"LimeRickDemo\")\n```\n\n### Low-level API function calls vs. function wrappers\n\n```{r, echo=TRUE, eval=TRUE, cache=FALSE}\n# low-level API call\nlsAPI(method = \"release_session_key\")\n\n# API call using a wrapper function\nlsSessionKey(\"release\")\n```\n\n### Setting a connection to a survey\n\n```{r, echo=TRUE, eval=TRUE, cache=FALSE}\n# getting session key for the user and saving it inside a special environment\nlsSessionKey(\"set\")\n\n# if you work with specific local set it now\nSys.setlocale(\"LC_ALL\", \"Polish\")\n```\n\n\n### Listing available surveys\n\n```{r, echo=TRUE, eval=TRUE, cache=FALSE}\n# listing available surveys\n(surveyList = lsList(\"surveys\"))\n\n# extracting ID of demo survey\nsurveyID = surveyList$sid[1] \n```\n\n### Adding responses via on-line survey questionaire\n\n```{r, echo=TRUE, eval=FALSE, cache=FALSE}\n# try submit your own answers to the demo survey\nbrowseURL(paste0(\"http://odgar.pl/survey/index.php/survey/index/sid/\", surveyID))\n```\nor use this link: http://odgar.pl/survey/index.php/survey/index/sid/683736\n\n### Listing survey questions\n\n```{r, echo=TRUE, eval=TRUE, cache=FALSE}\nquestionList = lsList(\"questions\", surveyID)\n```\n\n### Accessing survey or question properites\n\nWe can access 22 question properties and 58 survey properties. For example:\n```{r, echo=TRUE, eval=TRUE, cache=FALSE}\n# Is the survey active? (Y - Yes)\nlsGetProperties('survey', surveyID)$active\n\n# What is the main text of a given question?\nlsGetProperties('question', surveyID, 16)$question\n\n# Is the question mandatory? (Y - Yes)\nlsGetProperties('question', surveyID, 16)$mandatory\n```\n\n### Checking survey response\n\n```{r, echo=TRUE, eval=TRUE, cache=FALSE}\nlsGetSummary(surveyID)\n```\n\n### Importing responses into R\n\n```{r, echo=TRUE, eval=TRUE, cache=FALSE}\nd = lsGetResponses(surveyID, completionStatus = 'complete')\ntail(d)\n```\n\n### Adding responses via R\n\n```{r, echo=TRUE, eval=TRUE, cache=FALSE}\n# showing possible options for a particular question\nlsGetAnswerOptions(surveyID, questionID = 16)\n\n# specifying a response with the use of question code: surveIDXgroupIDXquestionID\nresponse = list('683736X2X27' = \"LimeRick\",\n                '683736X2X26' = \"Adding feedback directly from R\",\n                '683736X2X16' = \"A2\",# Academia\n                '683736X2X21' = \"174\" # Poland\n                )\n\n# adding the above response \nlsAddResponse(surveyID, response)\n\n# or adding via wrapper function\nlsAddFeedback(feedback = \"Good job! (Kamil, Poland)\", \n              sector = \"academia\", \n              country = \"Poland\")\n```\n\n## See also:\n\n* LimeSurvey Project Team / Carsten Schmitz (2015). / LimeSurvey: An Open Source survey tool /LimeSurvey Project Hamburg, Germany. URL http://www.limesurvey.org\n\n\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkalimu%2Flimerick","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkalimu%2Flimerick","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkalimu%2Flimerick/lists"}