Skip to content

Latest commit

 

History

History
215 lines (165 loc) · 9.75 KB

README.md

File metadata and controls

215 lines (165 loc) · 9.75 KB
Raw

Hi 👋, We are Team-Rosalind 💝

The team of 30 people for HackBio'2020 Virtual Bioinformatics Internship 🖨️

team-rosalind

tbi_internship ssiddhaantsharma ucrp4skeqrnbax0od3ybyt1w

Project

GitHub last commit GitHub issues Contributions welcome Maintenance Team Rosalind PRs Welcome License

HackBio
Image Source: @tbi_internship

This is the main repository for the HackBio'2020 Virtual Internship Experience.
Main goal of the project is write small scripts in different languages with the next output in sdout - name, e-mail, used_language, biostack, slack_username. Next step is to make csv file with rows corresponding to the person and columns to the values (as name, e-mail, etc) in bash, using sdout from scripts.

For neat-looking documentation check out Team-Rosalind

Banner
forthebadge forthebadge forthebadge

🚩 Table of content

🤖 Getting Started

Prerequisites

Random GIF

🎨 Running the tests

Check if dependencies are satisfied

Script for tests (tests.sh) is included in the repo. You can run it with the following command:

wget https://raw.githubusercontent.com/Team-Rosalind/team-rosalind-project/master/tests.sh && sh tests.sh

The above command will download only the target script and check if all required software is already installed.

Installing missing dependencies

Ubuntu

sudo apt-get update && sudo apt-get install python octave julia gcc g++ r nodejs npm

Please note, that Ubuntu-based installation hasn't been checked yet. Command based on Google search results. If you have any problems please report an issue and try official instruction for every package as stated on official sites

Arch-based distributions

sudo pacman -Su && sudo pacman -S python octave julia gcc nodejs npm

Installing

The main goal of the project is to create a bash script that will clone the repo and produce a csv file with the participants' personal information. For this goal no installation is required, however check if all dependencies are satisfied.

📜 Flowchart

WorkFlow_HackBio
Made using diagrams.net

🔧 Usage

Please download the following script csv-producer.sh. Downloading and running the script can be done from a terminal with the following command:

wget https://raw.githubusercontent.com/Team-Rosalind/team-rosalind-project/master/csv-producer.sh && sh csv-producer.sh

Script is intended to work in Linux-based systems and Windows PowerShell.

Terminal

🌏 Versioning

  • README.md -> v 2.2
  • csv-producer -> v 2.0
  • stage_0_Anu.C v 1.1
  • stage_0_Suritra.cpp -> v 1.0
  • stage_0_Vika.m -> v 1.0
  • stage_0_dolu.js -> v 1.1
  • stage_0_harinath.C -> v 1.0
  • stage_0_hildred.py -> v 1.6
  • stage_0_pavlo.jl -> v 1.0
  • stage_0_rajvi.jl -> v 1.0
  • stage_0_rupa.py -> v 1.0
  • stage_0_shirine.R -> v 1.0
  • stage_0_Alaa.py -> v 1.1
  • stage_0_Nicole.R -> v 1.2
  • stage_0_Omobolanle.js -> v 1.0
  • stage_0_Rajeswari.py -> v 1.2
  • stage_0_Ravindran.py -> v 1.2
  • stage_0_Richard.py -> v 1.1
  • stage_0_siddhant.py -> v 1.3
  • stage_0_theSamurai1997.m -> v 1.0
  • Stage_0_Ife.R -> v 1.0
  • Stage_0_Leye.py -> v 1.2
  • Stage_0_Busayo.py -> v 1.1
  • Stage_0_Ayobami1517.R -> v 1.2
  • Stage_0_Nirvana.py -> v 1.0
  • Stage_0_Rasheed.R -> v 1.0
  • Stage_0_TheSussex.py -> v 1.1
  • Stage_0_kaybee.py -> v 1.1

💬 For participants

Goals (Stage 0):

  • Make this documentation neat and nice. (Novice Friendly)
  • Complete task 2 (multiple languages)
  • Make a simple bash script for git commit

Language check

  • Python
  • Julia
  • C++
  • R
  • Java
  • MATLAB
  • Javascript
  • C

Note: The checklist has 8 languages right now. The minimum required amount is 7. If it is not satisfied, please choose unchecked languages from a list.

I am not a coder, what should I choose?

Everyone began from something (: Actually the language in this task doesn't matter, as the script is very simple. You can search smth similar to "write hello world script in language_of_interest ".

If all of the languages are checked, and the requirements (about programming language variety) are satisfied, you are free to choose whatever language you like. A good start is to become more familiar with R or Python. Both of these languages are extremely popular within the bioinformatics community. See templates for "Hello world script" for R and Python.

Unified template for output

Human text is an excellent example of unstructured data. Desired fields (for this task) can be printed out in many different ways. Therefore I propose a unified template for your script output:

NAME: *Your full name*
E-MAIL: *Your e-mail* 
USED LANGUAGE: *Name of used scripted language. All letters are capital*
BIOSTACK: *Name of biostack you chose. The only first letter is capital* 
SLACK USERNAME: @+*username*

An example:

NAME: Pavlo Hrab
E-MAIL: [email protected]
USED LANGUAGE: JULIA
BIOSTACK: Genomics
SLACK USERNAME: @pavlo

After you get the desired output, please name your file stage_0_slack-username
An example: stage_0_pavlo.jl

Generate a new table of content

The table of content was generated here Please if you do any updates to file itself, update a table of content as well

🚀 Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated 🎉 Working on your first Pull Request? How to Contribute to an Open Source Project on GitHub

  1. Clone the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Thanks! ❤️

Footer