Skip to content

Commit cd74f91

Browse files
Merge pull request #149 from oss-slu/Meltshiny_update
updated Tech Lead name,Current developers names,updated the content
2 parents 05ffe57 + be744ec commit cd74f91

File tree

3 files changed

+54
-20
lines changed

3 files changed

+54
-20
lines changed

docs/project_meltshiny/about.md

Lines changed: 49 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,28 @@ custom_edit_url: https://github.com/oss-slu/MeltWin2.0
66

77
## Overview
88

9-
MeltShiny is a software application that automates the analysis and visualization of DNA melting curves for researchers in chemistry, biology, and genetics. It is built on tools like MeltWin and MeltR, resulting an intuitive graphical user interface with robust data processing capabilities powered by R. MeltShiny removes the need for manual curve fitting with just a few clicks, researchers can upload their DNA melting data and automatically generate graphs and tables. Key benefits include automated outlier removal, compatibility with modern operating systems, and accessibility for non-programmers. By streamlining tedious tasks like handling file formats and filtering data, MeltShiny allows researchers to focus their time on scientific analysis and interpretation. Its simple yet powerful interface makes complex computational analysis of DNA thermodynamics accessible to scientists with varied technical skill levels.
9+
MeltShiny is a software application that automates the analysis and visualization of DNA melting curves for researchers in chemistry, biology, and genetics. It is built on tools like MeltWin and MeltR, resulting an intuitive graphical user interface with robust data processing capabilities powered by R. MeltShiny removes the need for manual curve fitting with just a few clicks, researchers can upload their DNA melting data and automatically generate graphs and tables. Key benefits include automated outlier removal, compatibility with modern operating systems, and accessibility for non-programmers. By streamlining tedious tasks like handling file formats and filtering data, MeltShiny allows researchers to focus their time on scientific analysis and interpretation. Its simple yet powerful interface makes complex computational analysis of DNA thermodynamics accessible to scientists with varied technical skill levels.
1010

1111
### Information
1212

1313
- **Source Code:** [https://github.com/oss-slu/MeltWin2.0](https://github.com/oss-slu/MeltWin2.0) [<img src="/img/git-alt.svg" alt="git" width="25" height="25" />](https://github.com/oss-slu/MeltWin2.0)
1414
- **Clients:**
1515
- [Dr. Brent Znosko](https://www.slu.edu/science-and-engineering/academics/chemistry/faculty/brent-znosko.php)
1616
- Sebastian Arteaga (Assistant)
17-
- **Current Tech Lead:** Sailikhita Pulijala [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/LikhitaPulijala)
17+
- **Current Tech Lead:** Pranitha Bollepalli [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/BollepalliPranitha)
1818
- **Developers:**
1919

20-
- Zohaib Ahmed (capstone) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/zohaib-a-ahmed)
21-
- Ethan Gray (capstone) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/ethan-gray-01)
22-
- Massimo Evelti (capstone) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/Massi-Papi)
23-
- Uday Prasad Aitha (alumni, previous tech lead) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/aithaprasad)
24-
- Shlok Patel (alumni) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/shlokpat6)
25-
- Colleen Wade (alumni) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/cwade6)
26-
- Anthony Hampton (alumni) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/adhampton110)
20+
- Andrew Vazzano (capstone) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/avazzano7)
21+
- Samuel Mercier (capstone) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/Canada101)
22+
- Swetha Repalli (capstone) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/srepalli3)
23+
- Zohaib Ahmed (alumni) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/zohaib-a-ahmed)
24+
- Ethan Gray (alumni) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/ethan-gray-01)
25+
- Massimo Evelti (alumni) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/Massi-Papi)
26+
- Uday Prasad Aitha (alumni, prior tech lead) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/aithaprasad)
27+
- Sailikhita Pulijala (alumni, prior tech lead) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/LikhitaPulijala)
28+
- Shlok Patel (alumni) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/shlokpat6)
29+
- Colleen Wade (alumni) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/cwade6)
30+
- Anthony Hampton (alumni) [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/adhampton110)
2731

2832
- **Start Date:** July 2022
2933
- **Adoption Date:** July 2022
@@ -35,7 +39,31 @@ MeltShiny is a software application that automates the analysis and visualizatio
3539

3640
### User Guide
3741

38-
MeltShiny has some dependencies which will need to be installed for the program to run. R Package installer files have been included, with the names MeltShinyDependenciesInstaller.command and MeltShinyDependenciesInstaller.bat for MacOS and Windows, respectively. These files are found within the MacOS_Scripts and Windows_Scripts folders found within the MeltShiny application bundle.Note, that in order for the Windows version to work, you must add the R bin folder to your PATH variable. For MacOS, the script can be used without any additional work. Double clicking MeltShinyDependenciesInstaller.command or MeltShinyDependenciesInstaller.bat for Mac and Windows, respectively, will open up a terminal.
42+
MeltShiny is a web-based tool designed for researchers to easily analyze and visualize DNA melting curves.
43+
44+
**Access the Web App**: Open the MeltShiny web app on any modern browser.
45+
46+
**Upload Your Data**: Use the "Upload Data" section to upload files in .csv format.
47+
48+
**Visualize Results**: Customize and generate graphs in the "Visualize Data" section to explore melting curves and other data.
49+
50+
**Analyze and Export**: View detailed thermodynamic parameters in the "Analysis" section and export findings in preferred formats.
51+
52+
**Get Help**: Visit the "Help" section for guides and support, or contact our team directly for assistance.
53+
54+
MeltShiny streamlines complex DNA data analysis, allowing researchers to focus on scientific insights.
55+
56+
## Installation
57+
58+
MeltShiny requires specific dependencies to function correctly. Installation files for R packages are included in the application bundle:
59+
60+
- **MacOS**: MeltShinyDependenciesInstaller.command (located in the MacOS_Scripts folder)
61+
- **Windows**: MeltShinyDependenciesInstaller.bat (located in the Windows_Scripts folder)
62+
63+
**Important Notes:**
64+
65+
- **Windows Users**: Ensure that the R bin folder is added to your PATH variable for proper execution.
66+
- **MacOS Users**: The script can be run directly without additional configuration.
3967

4068
## Technical Information
4169

@@ -45,11 +73,17 @@ MeltShiny has some dependencies which will need to be installed for the program
4573

4674
### Development Priorities
4775

48-
- Latest R version required
49-
- Knowledge on Shiny server
50-
- Implement user-friendly UI
51-
- Require automated testing
52-
- Version Control and Collaboration
76+
- **Latest R version required** : Ensure compatibility with the most recent version of R.
77+
- **Knowledge on Shiny server** : Expertise in Shiny server setup and management.
78+
- **Implement user-friendly UI** : Develop a clean, intuitive interface for ease of use.
79+
- **Require automated testing** : Implement comprehensive testing to ensure reliability.
80+
- **Version Control and Collaboration** : Utilize version control systems and collaboration tools for effective project management.
81+
82+
### Additional Details:
83+
84+
- **Project Goals**: Improve user experience by continuously incorporating feedback from researchers and addressing emerging needs in DNA melting curve analysis.
85+
- **Future Enhancements**: Explore integration with additional data formats, enhance error-handling capabilities, and expand visualization options.
86+
- **Community Engagement**: Actively seek contributions from the open-source community to foster collaboration and innovation.
5387

5488
## Get Involved
5589

package-lock.json

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
"clsx": "^1.2.1",
2424
"docusaurus": "^1.14.7",
2525
"jpegtran-bin": "^7.0.0",
26-
"prism-react-renderer": "^2.1.0",
26+
"prism-react-renderer": "^2.4.0",
2727
"react": "18.2.0",
2828
"react-dom": "18.2.0"
2929
},

0 commit comments

Comments
 (0)