Data

Tools

Indexes

Applications

Experiments

Open Source Science

spezichoir

Spezi Package for the Stanford CHOIR System

https://github.com/stanfordspezi/spezichoir

Science Score: 67.0%

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

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (8.7%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Spezi Package for the Stanford CHOIR System

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

README.md

SpeziCHOIR

Main codecov DOI

Spezi CHOIR integrates ResearchKit surveys with the Stanford CHOIR system.

|Screenshot of question without answer fields Screenshot of question without answer fields|Screenshot of question with `radios` type answer field Screenshot of question with `radios` type answer field| Screenshot of question with `text` type answer fields Screenshot of question with `text` type answer fields | |:--:|:--:|:--:| |CHOIRQuestions rendering instructions without answer options|CHOIRQuestions rendering radios type question|CHOIRQuestions rendering text type questions|

The package contains two targets: - SpeziCHOIR: Handles interactions with the CHOIR API - SpeziCHOIRViews: Provides views for rendering survey questions

You use the CHOIRQuestions view to visualize a CHOIR survey.

Setup

1. Add Spezi CHOIR as a Dependency

You need to add the SpeziCHOIR Swift package to your app in Xcode or Swift package.

[!IMPORTANT]
If your application is not yet configured to use Spezi, follow the Spezi setup article to set up the core Spezi infrastructure.

2. Add the Module to your App

Add the CHOIRModule to your App's configuration: ```swift import Spezi import SpeziCHOIR

class ExampleAppDelegate: SpeziAppDelegate { override var configuration: Configuration { Configuration { CHOIRModule(service: CHOIRService(serverURL: URL(string: "https://choir.example.com")!)) // your other modules... } } } ```

The CHOIRAccountStorageProvider can be added to your App's account configuration like so: ```swift import Spezi import SpeziAccount import SpeziCHOIR import SpeziFirebaseAccount

class ExampleAppDelegate: SpeziAppDelegate { override var configuration: Configuration { Configuration { AccountConfiguration( service: FirebaseAccountService( providers: [.emailAndPassword] ), storageProvider: CHOIRAccountStorageProvider(siteId: "exampleSite"), configuration: CHOIRService.valueConfiguration ) // your other modules... } } } ```

License

This project is licensed under the MIT License. See Licenses for more information.

Contributors

This project is developed as part of the Stanford Byers Center for Biodesign at Stanford University. See CONTRIBUTORS.md for a full list of all TemplatePackage contributors.

Stanford Byers Center for Biodesign Logo Stanford Byers Center for Biodesign Logo

Owner

  • Name: Stanford Spezi
  • Login: StanfordSpezi
  • Kind: organization

Citation (CITATION.cff) 

#
# This source file is part of the Stanford Spezi open source project
#
# SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
#
# SPDX-License-Identifier: MIT
# 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Schmiedmayer"
  given-names: "Paul"
  orcid: "https://orcid.org/0000-0002-8607-9148"
- family-names: "Madlener"
  given-names: "Nikolai"
  orcid: "https://orcid.org/0009-0006-5059-6617"
title: "SpeziCHOIR"
doi: 10.5281/zenodo.7538165
url: "https://github.com/StanfordSpezi/SpeziCHOIR"

GitHub Events

Total
  • Release event: 3
  • Watch event: 1
  • Delete event: 3
  • Issue comment event: 3
  • Push event: 10
  • Public event: 1
  • Pull request review event: 3
  • Pull request event: 6
  • Create event: 4
Last Year
  • Release event: 3
  • Watch event: 1
  • Delete event: 3
  • Issue comment event: 3
  • Push event: 10
  • Public event: 1
  • Pull request review event: 3
  • Pull request event: 6
  • Create event: 4

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 0
  • Total pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 7 days
  • Total issue authors: 0
  • Total pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 2.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 7 days
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 2.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • PSchmiedmayer (1)
  • NikolaiMadlener (1)
Top Labels
Issue Labels
Pull Request Labels
enhancement (1) documentation (1)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 3
swiftpackageindex.com: github.com/StanfordSpezi/SpeziCHOIR

Spezi Package for the Stanford CHOIR System

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 16.9%
Average: 20.3%
Dependent repos count: 23.7%
Last synced: 10 months ago

Dependencies

.github/workflows/build-and-test.yml actions
.github/workflows/main.yml actions
.github/workflows/pull_request.yml actions
Package.swift swiftpm