readSX

Read SurveyXact Data into R

https://github.com/NIFU-NO/readSX

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
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.4%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Read SurveyXact Data into R

Basic Info
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 3
  • Releases: 0
Created almost 4 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog License

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# readSX


[![Lifecycle: stable](https://lifecycle.r-lib.org/articles/figures/lifecycle-stable.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![CRAN status](https://www.r-pkg.org/badges/version/readSX)](https://CRAN.R-project.org/package=readSX)
[![R-CMD-check](https://github.com/sda030/readSX/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/sda030/readSX/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/sda030/readSX/branch/main/graph/badge.svg)](https://app.codecov.io/gh/sda030/readSX?branch=main)
[![Codecov test coverage](https://codecov.io/gh/sda030/readSX/graph/badge.svg)](https://app.codecov.io/gh/sda030/readSX)


The goal of readSX is to import survey data collected from the proprietary service SurveyXact. SurveyXact exports data in multiple tables: raw data, variable labels (and types), and value labels. 

## Installation

``` r
install.packages("readSX")

```

You can install the development version of readSX like so:

``` r
library(devtools)
devtools::install_github("sda030/readSX")
```

## Example

```{r example}
library(readSX)
ex_survey2_xlsx <-
      read_surveyxact(filepath =
                      system.file("extdata", "ex_survey2.xlsx",
                      package = "readSX", mustWork = TRUE))
```

## Features
- Fixes legacy bugs in the SurveyXact data export.
- Ensures data can be read no matter which data export format (Excel, CSV, ansi/utf8, comma/semicolon-separated).
- Can read non-ASCII characters correctly - tested with Norwegian æøå.
- As of version 1.8.2, applies factors for labelled values. (prior versions used the value labels-system of the labelled-package, which is only intended for Stata/SPSS/SAS where there can be multiple missing value codes). In SurveyXact, only blanks can be used for explicit missing, so this feature was redundant and confusing. Stick to R's native factor vectors.
- As of 1.8.4, contains function to ensure uploaded CSV file with respondents is in correct format.


## TODO:
- Tick boxes do not get correct label suffix? Automatically fix NA/FALSE for these? 
- Get SX to fix the bug in labels header
- Get SX to fix the bug in Excel-sheets being separated into dataset(1)(2), etc.
-	Get SX to fix bug in Structure.csv having a phantom column at the end...

Owner

  • Name: NIFU-NO
  • Login: NIFU-NO
  • Kind: organization

GitHub Events

Total
  • Push event: 5
  • Pull request event: 1
  • Create event: 1
Last Year
  • Push event: 5
  • Pull request event: 1
  • Create event: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 0
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: about 23 hours
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: about 23 hours
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • sda030 (2)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

DESCRIPTION cran
  • cli * imports
  • readxl * imports
  • rlang * imports
  • utils * imports
  • covr * suggests
  • testthat >= 3.0.0 suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/check-r-package v2 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/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action 4.1.4 composite
  • actions/checkout v2 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/pr-commands.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/pr-fetch v2 composite
  • r-lib/actions/pr-push v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout 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