koboconnectr

Download data from Kobotoolbox to R

https://github.com/asitav-sen/koboconnectr

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (19.0%) to scientific vocabulary

Keywords

kobotoolbox kobotoolbox-api r

Last synced: 10 months ago · JSON representation

Repository

Download data from Kobotoolbox to R

Basic Info

Host: GitHub
Owner: asitav-sen
License: gpl-3.0
Language: R
Default Branch: main
Homepage: https://asitav-sen.github.io/KoboconnectR/
Size: 10.4 MB

Statistics

Stars: 13
Watchers: 2
Forks: 2
Open Issues: 13
Releases: 5

Topics

kobotoolbox kobotoolbox-api r

Created almost 5 years ago · Last pushed over 1 year ago

Metadata Files

Readme Changelog License Codemeta

KoboconnectR

The goal of KoboconnectR is to facilitate data extraction from Kobotoolbox projects/assets into R, instead of downloading the individual spreadsheet files.

Installation

CRAN version can be downloaded with:

r install.packages("KoboconnectR")

The effort is still in its early stage. The development version can be installed from GitHub with:

``` r

install.packages("devtools")

devtools::install_github("asitav-sen/KoboconnectR") ```

Getting started

Before being able to use the kobotoolbox API, one needs to set up API token. The kobotoolbox documentation lists multiple ways for one to extract the token value. If there is a token, the easiest way to retrieve it is by using get_kobo_token() function.

r kobotools_kpi_data(assetid = "assetid", url = "eu.kobotoolbox.org", uname = "username", pwd = "password")

To find the asset id, one can use the kobotools_api() function that returns a list of assets the user has access to.

r kobotools_api(url = "eu.kobotoolbox.org", simplified = T, uname = "userid", pwd = "password")

Downloading data

r KoboconnectR::kobo_df_download( uname = "username", pwd = "password", assetid = "assetid", all = "false", lang = "_default", hierarchy = "false", include_grp = "true", grp_sep = "/", fsep = ";", multi_sel = "both", media_url = "true", fields = NULL, sub_ids = NULL, sleep = 2 )

IF THE DOWNLOAD FAILS, TRY INCREASING THE SLEEP PARAMETER (use the latest version please, dev version, if required).

For further details, check the vignette.

Contribution

The package is stable but still in early stages of development. Any help to enhance it further will be highly appreciated. Please feel free to fork, add/modify and create pull requests.

Issues and Suggestions

Please feel free to add issue of suggestions in github

Dependencies

The following packages are required to install and run this package.

Package httr2
Package jsonlite
Package curl
Package mime
Package openssl
Package R6
Package methods
Package readxl
Package rlang
Package purrr

Owner

Name: Asitav Sen
Login: asitav-sen
Kind: user

Website: https://asitavsen.com
Repositories: 3
Profile: https://github.com/asitav-sen

Data and Decision Science for Business and Society

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "KoboconnectR",
  "description": "Wrapper for 'Kobotoolbox' APIs ver 2 mentioned at <https://support.kobotoolbox.org/api.html>, to download data from 'Kobotoolbox' to R. Small and simple package that adds immense convenience for the data professionals using 'Kobotoolbox'.",
  "name": "KoboconnectR: Download Data from Kobotoolbox to R",
  "relatedLink": [
    "https://asitav-sen.github.io/KoboconnectR/",
    "https://CRAN.R-project.org/package=KoboconnectR"
  ],
  "codeRepository": "https://github.com/asitav-sen/KoboconnectR",
  "issueTracker": "https://github.com/asitav-sen/koboconnectR/issues",
  "license": "https://spdx.org/licenses/GPL-3.0",
  "version": "2.0.0",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.4.1 (2024-06-14)",
  "provider": {
    "@id": "https://cran.r-project.org",
    "@type": "Organization",
    "name": "Comprehensive R Archive Network (CRAN)",
    "url": "https://cran.r-project.org"
  },
  "author": [
    {
      "@type": "Person",
      "givenName": "Asitav",
      "familyName": "Sen",
      "email": "codes@asitavsen.com"
    }
  ],
  "copyrightHolder": [
    {
      "@type": "Person",
      "givenName": "Asitav",
      "familyName": "Sen",
      "email": "codes@asitavsen.com"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Asitav",
      "familyName": "Sen",
      "email": "codes@asitavsen.com"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=knitr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "spelling",
      "name": "spelling",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=spelling"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "version": ">= 3.0.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "httr2",
      "name": "httr2",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=httr2"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "curl",
      "name": "curl",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=curl"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "jsonlite",
      "name": "jsonlite",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=jsonlite"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "mime",
      "name": "mime",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=mime"
    },
    "5": {
      "@type": "SoftwareApplication",
      "identifier": "openssl",
      "name": "openssl",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=openssl"
    },
    "6": {
      "@type": "SoftwareApplication",
      "identifier": "R6",
      "name": "R6",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=R6"
    },
    "7": {
      "@type": "SoftwareApplication",
      "identifier": "methods",
      "name": "methods"
    },
    "8": {
      "@type": "SoftwareApplication",
      "identifier": "dplyr",
      "name": "dplyr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=dplyr"
    },
    "9": {
      "@type": "SoftwareApplication",
      "identifier": "readxl",
      "name": "readxl",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=readxl"
    },
    "10": {
      "@type": "SoftwareApplication",
      "identifier": "rlang",
      "name": "rlang",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rlang"
    },
    "11": {
      "@type": "SoftwareApplication",
      "identifier": "purrr",
      "name": "purrr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=purrr"
    },
    "SystemRequirements": null
  },
  "fileSize": "99.772KB",
  "releaseNotes": "https://github.com/asitav-sen/KoboconnectR/blob/master/NEWS.md",
  "readme": "https://github.com/asitav-sen/KoboconnectR/blob/main/README.md",
  "contIntegration": "https://github.com/asitav-sen/KoboconnectR/actions",
  "keywords": [
    "kobotoolbox",
    "kobotoolbox-api",
    "r"
  ]
}

GitHub Events

Total

Issues event: 3
Issue comment event: 9
Push event: 4

Last Year

Issues event: 3
Issue comment event: 9
Push event: 4

Committers

Last synced: over 2 years ago

All Time

Total Commits: 50
Total Committers: 2
Avg Commits per committer: 25.0
Development Distribution Score (DDS): 0.14

Past Year

Commits: 4
Committers: 1
Avg Commits per committer: 4.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
asitav-sen	a**n@g**m	43
Asitav Sen	6****n	7

Issues and Pull Requests

Last synced: 10 months ago

All Time

Total issues: 23
Total pull requests: 0
Average time to close issues: 3 months
Average time to close pull requests: N/A
Total issue authors: 17
Total pull request authors: 0
Average comments per issue: 4.22
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 3
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 3
Pull request authors: 0
Average comments per issue: 3.0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

manhnguy (3)
moloscripts (2)
zxrey (2)
andresimi (2)
xboschc (2)
TheDataAreClean (1)
jeroen (1)
cadubio (1)
jacintomathe (1)
faisalsoft (1)
AbdulrahamanMusa (1)
dankilemi (1)
mbk7162 (1)
novarela (1)
rkopper610 (1)

Pull Request Authors

Top Labels

Issue Labels

enhancement (3) help wanted (1)

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- cran 366 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 7
Total maintainers: 1

cran.r-project.org: KoboconnectR

Download Data from Kobotoolbox to R

Homepage: https://github.com/asitav-sen/KoboconnectR
Documentation: http://cran.r-project.org/web/packages/KoboconnectR/KoboconnectR.pdf
License: GPL (≥ 3)
Latest release: 2.0.0
published almost 2 years ago

Versions: 7
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 366 Last month

Rankings

Stargazers count: 18.7%

Forks count: 21.9%

Dependent packages count: 29.8%

Average: 30.3%

Dependent repos count: 35.5%

Downloads: 45.7%

Maintainers (1)

hello@asitavsen.com

Last synced: 10 months ago

Dependencies

DESCRIPTION cran

R6 * imports
curl * imports
dplyr * imports
httr * imports
jsonlite * imports
methods * imports
mime * imports
openssl * imports
knitr * suggests
rmarkdown * suggests
spelling * suggests
testthat >= 3.0.0 suggests

.github/workflows/R-CMD-check.yaml actions

actions/checkout v2 composite
r-lib/actions/check-r-package v1 composite
r-lib/actions/setup-pandoc v1 composite
r-lib/actions/setup-r v1 composite
r-lib/actions/setup-r-dependencies v1 composite

.github/workflows/pkgdown.yaml actions

JamesIves/github-pages-deploy-action v4.4.1 composite
actions/checkout v3 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

.github/workflows/rhub.yaml actions

r-hub/actions/checkout v1 composite
r-hub/actions/platform-info v1 composite
r-hub/actions/run-check v1 composite
r-hub/actions/setup v1 composite
r-hub/actions/setup-deps v1 composite
r-hub/actions/setup-r v1 composite