Giter VIP home page Giter VIP logo

f5n's Introduction

Build Status

Genopo a.k.a. F5N is a nanopore sequencing analysis toolkit for Android smartphones

Overview

Genopo can run following analysis tools on mobile devices more details

  1. minimap2
  2. samtools
  3. f5c
  4. nanopolish
  5. bcftools
  6. artic_c
  7. bioawk

In particular, Genopo has buit in pipelines for

  1. Methylation Calling
  2. Event Alignment
  3. Variant Calling
  4. Consensus Building
  5. nCoV-2019 novel coronavirus bioinformatics protocol (Artic pipeline)

Real-time sequence analysis (in alpha phase)

Real-time methylation calling on nanopore sequencing batch datasets is experimented. More details can be found at here

Installation

Genopo application can be obtained from:

Google Play

Additionally you can get development builds from Github releases Chose ARCHITECTURE to be armeabi-v7a or arm64-v8a. To find what is the ARCHITECTURE of your phone the easiest way is to google it. Once you download the apk copy it to your phone and install.

VERSION=0.0.4
ARCHITECTURE=armeabi-v7a
wget "https://github.com/SanojPunchihewa/f5n/releases/download/$VERSION/mobilegenomics-f5n-v$VERSION-$ARCHITECTURE-release.apk"

Signature keys of builds are different. Before you switch the installation source, you will have to uninstall the existing Genopo application.

Demo

Configure single/multiple tools Help

Connecting to F5N server, downloading, running and sending results

Datasets

You can use publicly available datasets

How to contribute

Please contribute to our work by testing,debugging and developing our product. A guide to how to contribute is available here

Submit an issue

Please submit your issues here. Make sure your issue is not an existing one. If a similar issue already exists comment or vote under the existing issue.

f5n's People

Contributors

anjanasenanayake avatar hiruna72 avatar sanojpunchihewa avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

f5n's Issues

The log output is missing

Describe the bug
When a particular tool or the pipeline is run for a bit large dataset (a few thousand reads), sometimes the log output is not displayed at all. However, it seems to run to the end as the successful message appears after a while in around 30 seconds.

To Reproduce
Steps to reproduce the behavior:

  1. launch the f5n app
  2. goto standalone and select minimap
  3. fill in the arguments and then run the tool
  4. Observe that no log output

Expected behavior
The log should be displayed for all runs.

Screenshots
Screenshot_2019-11-17-19-15-12

Smartphone (please complete the following information):

  • Device: Device: LG Q6
  • OS: Android 8.1.0

set max memory for samtools sort according to device features

Problem-
app crashes in Samsung GT19500 if max memory (default 768M) is not reduced

Solution
Check device memory capacity and set it accordingly (in above case memory should be set to 300M <= Memory <=500M)

Alternative
Inform user about possible failure and let user set the value

Send Results back to the server

At the moment the app only sends a status message to the f5n server

Need to implement the following,

  • Upload the newly created files from minimap2, samtools and f5c
  • Send the log of the commands

x86 support

It depends on your user base and target audience. While x86 support is needed to run on Chromebooks, how many of your users are actually using your app on them? IIRC, Intel has pretty much given up on x86 chips for mobile devices, so unless you have tons of users on Chromebooks, you can skip it for now.

I think it is not difficult. let's try.

Add default argument values

Some of the tools don't display their default values in the configuration UI. To fix this update the JSON files

Unexpected behaviour when switched to another app when f5n is running

Describe the bug
While a command is running, if I switch to another app (eg: messenger) and later come back to f5n, the log outputs of f5n are missing (see screenshot). Then if I go back, the app crashes (see screenshot)

To Reproduce
Steps to reproduce the behavior:

  1. Run minimap2 on a dataset which takes around 1 minute to run. I tried a small dataset on chr22.
  2. While the command is running, goto messenger or any other app
  3. After around 2 minutes come back to f5c
  4. See that log output is missing
  5. then try to go back a few times (the back button in Android)
  6. f5n crashes

Screenshots

command run:
Screenshot_2019-11-01-11-59-02

after going to another app and coming back things are missing:
Screenshot_2019-11-01-12-01-02

Press back button few times:
Screenshot_2019-11-01-12-01-14

Smartphone (please complete the following information):

  • Device: LG Q6
  • OS: Android 8.1.0

samsort fails on armeabi-v7a

Describe the bug
where - commit 61b693f
issue - samsort fails.
error_message - failed to read header from "path/minimap2-out.sam"
possibly because minimap2 erroneously writes the header.

To Reproduce
Steps to reproduce the behavior:

  1. run minimap2
  2. use minimap2's output for samsort input

Expected behavior
should run samsort

Screenshots
Screenshot_2019-11-13-18-35-37

Smartphone (please complete the following information):

  • Device: Samsung GT19500
  • OS: [Android 5.0.1] armeabi-v7a
  • App Version 61b693f

Eventalign output that is generated is the summary output

Describe the bug
When the event align module is run, the output generated is the "f5c_event_align.summary.txt" file instead of the actual alignment output.

To Reproduce
Steps to reproduce the behaviour:
Run f5c event alignment and compare the generated output to that of f5c when run on a computer.

Expected behaviour
The actual event alignment output is expected.

Smartphone (please complete the following information):

  • Device: Device: LG Q6
  • OS: OS: Android 8.1.0

App crash in MinItActivity

Describe the bug
In the MinIt mode, app crashes when canceled the compress files popup in the upload results state.

To Reproduce
Steps to reproduce the behavior:

  1. Process a job in MinIt
  2. Go to upload result state in MinIt
  3. Press 'Compress Files' and cancel it.
  4. App crashes

Expected behavior
Popup should close without crashing the app

Screenshots

Smartphone (please complete the following information):

  • Device: LG X Screen
  • OS: Android 6
  • App Version:

Additional context

  • ArrayIndexOutOfBounds Exception

copy paste ip addresss

it is easier if copy/paste functionality is added for the activity where IP address is input.

Remove unused options from F5C

Some of the options in f5c are not used in the mobile version. It's better to remove those

  • help
  • version
  • skip unreadable

eventalignment not working

after 1b4cf09
1.f5c writes events.summary file to the executing location. --> input the path as a param
2.f5c writes results to the stdout --> input a file path to write results or pipe stdout and flush to a file

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.