Code Monkey home page Code Monkey logo

csx's Introduction

COLLABORATION SPOTTING X

Collaboration spotting X (CSX) is a network-based visual-analytics application for exploring tabular data through network visualizations, interactions, and advanced network analytics. The main aim of CSX is to enable users to retrieve a subset of their dataset and provide tools for visual and interactive exploration and filtering of their retrieved data in a network format. You can read more about the project on csxp.me.

Collaboration Spotting X - Screenshot

About & History πŸ“–

This project was developed by Aleksandar Bobić as part of his PhD research during his time as a doctoral student at CERN and the Graz University of Technology under the supervision of his CERN supervisor Jean-Marie Le Goff and his TU Graz supervisor Christian Gütl.

This project was inspired by concepts introduced in the previous Collaboration Spotting project. We would like to thank the previous Collaboration Spotting team for their contributions.

Contact βœ‰οΈ

If you would like to collaborate or contribute to the project or have any questions feel free to send me an email to [email protected].

Involved institutions 🏫

Contributors from the following institutions were involved in the development of this project:

CITATION ✍️

If you happen to mention or use this project as part of one of your scientific works, please cite the following paper: Bobic, A., Le Goff, JM., GΓΌtl, C. (2023). Exploring Tabular Data Through Networks. In: , et al. Advances in Information Retrieval. ECIR 2023. Lecture Notes in Computer Science, vol 13982. Springer, Cham. https://doi.org/10.1007/978-3-031-28241-6_13

CONTRIBUTORS πŸ™ŒπŸ₯³πŸ™ŒπŸ₯³πŸ™ŒπŸ₯³

A big thank you to all contributiors of this project:

@LorenaEgger

TUTORIALS πŸ“–

Collaboration Spotting X - Preview

Selected publications πŸ“š

  • Bobic, A., Le Goff, JM., GΓΌtl, C. (2023). Exploring Tabular Data Through Networks. In: , et al. Advances in Information Retrieval. ECIR 2023. Lecture Notes in Computer Science, vol 13982. Springer, Cham. https://doi.org/10.1007/978-3-031-28241-6_13
  • Bobic, A., Le Goff, J. M., & GΓΌtl, C. (2021). Towards supporting complex retrieval tasks through graph-based information retrieval and visual analytics. In CEUR Workshop Proceedings (Vol. 2950, pp. 30-37). RWTH Aachen. Presentation Video
  • Bobic, A., Le Goff, J. M., & GΓΌtl, C. (2021). Collaboration Spotting X-A Visual Network Exploration Tool. In in Proceedings of the The Eighth International Conference on Social Networks Analysis, Management and Security: SNAMS 2021. Presentation Video

Getting started 🏁

To start developing this project, please complete the following steps:

  1. Install docker
  2. Clone the CSX project
  3. Start docker
  4. In a terminal, navigate to the project directory and run docker-compose up, which will start the app in development mode.
  5. Once the project is running, it will be accessible on http://localhost:8882
  6. Upload the example file just_sm.csv from the datasets_example folder.

Contributing πŸ§‘β€πŸ’»

If you want to contribute to this project, pick an open issue you find interesting and create your branch (from the develop branch) with the issue number as the branch name. If there is no open issue for your feature, please open a new issue with a detailed description of the feature first.

Once you are happy with your implementation, open a pull request to the develop branch.

Developing πŸ§‘β€πŸ’»

Starting the project and populating elastic with the sample dataset

Run docker-compose up, which will start the app in development mode on http://localhost:8882

Navigate to the dataset_examples folder and drag and drop the example file just_sm.csv into the csx drop zone to populate the running elastic instance with sample data collected from the Journal of Universal Computer Science.

To add a custom dataset simply prepare a CSV file with the following format (make sure there are no single quotation marks in the text since that might interfere with the automatic processing of list values):

String feature name Category feature name Number feature name List feature name
Some string value. Categorical val 1 1 ["val1","val2","val3"]
Another string value Categorical val 2 (same as a string) 4.35 ["val6","val4","val1"]

When the dataset is uploaded a config file is created in the server/app/data/config folder. This file defines the default configuration for a dataset.

🚨 Config files should never be manually modified. If you want to modify the config of a dataset either click on the change default settings for dataset button next to each of the datasets on the homepage or delete the dataset and upload it again with different settings.:

Running development with analytics enabled

In additiona to making sure the flag REACT_APP_DISABLE_TRACKING in ./app/.env.development is set to false you must run the docker-compose command with particular parameters: docker-compose --profile analytics up

On the first run make sure to visit localhost:8883 and go through the matomo setup process.

Feature Flags

To configure, disable or enable various csx features visit the ./app/.env.{development/production} file and set the desired value. The following feature flags are available:

Flag name What it does Values
REACT_APP_DISABLE_UPLOAD Disable or enable the file upload features true / false
REACT_APP_DISABLE_DATASET_LIST Disable or enable the dataset list component true / false
REACT_APP_DISABLE_UPLOAD Disable or enable the file upload features true / false
REACT_APP_DISABLE_DATASET_DOWNLOAD Disable or enable the file download feature true / false
REACT_APP_DISABLE_ADVANCED_SEARCH Disable or enable the advanced search feature true / false
REACT_APP_DISABLE_TRACKING Disable or enable tracking true / false
REACT_APP_SURVEY_LINK Link to your survey string (including https)
REACT_APP_SURVEY_LINK_USER_ID The link variable used for unique IDs. string
REACT_APP_SURVEY_MESSAGE The message that should show up when the survey popup displays. string
REACT_APP_SURVEY_SHOW_AFTER_HISTORY_DEPTH Dispaly the survey popup after a user performs a particular number of actions on a graph number (int)

Starting the project in production mode πŸš€

Run docker-compose -f docker-compose.prod.yml up --build --remove-orphans --force-recreate

Runs the app in production mode. Open http://localhost:8880 to view it in the browser.

Running production mode with analytics enabled

In additiona to making sure the flag REACT_APP_DISABLE_TRACKING in ./app/.env.production is set to false you must run the docker-compose command with particular parameters: MATOMO_PASS=your_db_pass docker-compose -f docker-compose.prod.yml --profile analytics up --build --remove-orphans --force-recreate

csx's People

Contributors

aleksbobic avatar lorenaegger avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.