Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/weinbergerlab/wisspar


https://github.com/weinbergerlab/wisspar

Last synced: 14 days ago
JSON representation

Awesome Lists containing this project

README 

        
# WISSPAR - Project



##About Project

The Worldwide Index of Serotype Specific Pneumococcal Antibody Responses (WISSPAR) is a centralized platform housing data on immunogenicity from clinical trials of pneumococcal vaccines.  The data on WISSPAR are primarily curated from outcomes tables from clinicaltrials.gov and are made available in a searchable format that can be readily used for downstream analyses. Fields included in the database include product, manufacturers, dosing schedule, age group, and geographic region. You can use the embedded tools to generate customizable visualizations, export data for further analyses, or just browse through clinical trial results.



## Technical Documentation

This is a golang/svelte MPA project that uses the Ent framework for the custom schema.



## /app

This folder houses the golang code which acts as the backend http server and rest api.



### /app/gen/models

This folder is auto generated from `/app/schema` using the `go generate ./app/generator` command. DO NOT EDIT THIS FOLDER.



## /assets

This folder houses the svelte assets for the project to be compiled into the public folder.



# Live Data

This link will generate the most up to date CSV: https://wisspar.com/export-options/data-export/?use_case=pcv_antibodies&default=true



## Search Options

Here are a list of search options you can use:

 - use_case (example value=pcv_anitbodies) single value

 - income_groups (Values = High income, Upper middle income, Lower middle income, Low income, Not classified) multi value

 - vaccine (Values are set in admin) multi value

 - phase (Values = Phase 1, Phase 2, Phase 3, Phase 4) multi value 

 - std_age_list (Values = Child, Adult, Older Adult)  multi value

 - country_codes (ISO standard 2 letter country code)  multi value

 - continent_codes (ISO standard 2 letter continent code)  multi value

 - responsible_party (Values come from clinicaltrials.gov)  multi value

 - ethnicity_race (Values come from clinicaltrials.gov)  multi value

 - immunocompromised_populations (Values are set in admin) multi value



These two are used to combine field arrays in whatever way you need (you won't need to set it unless you have a specific reason)

 - parent_array_separator = (Default set to ',') single value

 - child_array_separator = (Default set to ' ') single value

 

How to use multi value in URL request: .../?vaccine=Vaccine 1&vaccine=Vaccine  2



## Field Options

Setting the default option to true will give you the following fields:



 - location_continent

 - study_eligibility_standard_age_list

 - clinical_trial_study_id

 - clinical_trial_phase

 - outcome_overview_time_frame

 - outcome_overview_assay

 - outcome_overview_dose_number

 - outcome_overview_serotype

 - outcome_overview_value

 - outcome_overview_vaccine

 - outcome_overview_dose_description

 - outcome_overview_schedule

 - outcome_overview_time_frame_weeks



However the whole list of fields you can set are below just use in URL request like this: "field_name=true" :

 - location_facility

 - location_city

 - location_country

 - location_country_code

 - location_continent

 - location_continent_code

 

 

 - study_eligibility_criteria

 - study_eligibility_healthy_volunteers

 - study_eligibility_gender

 - study_eligibility_minimum_age

 - study_eligibility_maximum_age

 - study_eligibility_standard_age_list

 - study_eligibility_ethnicity

 

 

 - clinical_trial_study_name

 - clinical_trial_study_id

 - clinical_trial_sponsor

 - clinical_trial_responsible_party

 - clinical_trial_study_type

 - clinical_trial_phase

 - clinical_trial_actual_enrollment

 - clinical_trial_allocation

 - clinical_trial_intervention_model

 - clinical_trial_masking

 - clinical_trial_primary_purpose

 - clinical_trial_official_title

 - clinical_trial_actual_study_start_date

 - clinical_trial_actual_primary_completion_date

 - clinical_trial_actual_study_completion_date

 

 

 - outcome_measure_type

 - outcome_measure_title

 - outcome_measure_description

 - outcome_measure_population_description

 - outcome_measure_reporting_status

 - outcome_measure_anticipated_posting_date

 - outcome_measure_param_type

 - outcome_measure_dispersion_type

 - outcome_measure_unit_of_measure

 - outcome_measure_calculate_pct

 - outcome_measure_time_frame

 - outcome_measure_type_units_analyzed

 - outcome_measure_denom_units_selected

 

 

 - outcome_overview_title

 - outcome_overview_id

 - outcome_overview_description

 - outcome_overview_time_frame

 - outcome_overview_assay

 - outcome_overview_dose_number

 - outcome_overview_participants

 - outcome_overview_serotype

 - outcome_overview_value

 - outcome_overview_upper_limit

 - outcome_overview_lower_limit

 - outcome_overview_ratio

 - outcome_overview_vaccine

 - outcome_overview_immunocompromised_population

 - outcome_overview_manufacturer

 - outcome_overview_dose_description

 - outcome_overview_schedule

 - outcome_overview_time_frame_weeks

 - outcome_overview_confidence_interval

 - outcome_overview_percent_responders



## Local Setup



### Prerequisites:

 - Docker

 - NPM

 - Yarn

 - Golang



In one terminal window run this command:

```

cd assets && yarn watch 

```

Then run this one in another terminal window:

```

docker-compose up app

```



You can access the website locally through: http://localhost:8023