adapter-parser/README.org

58 lines
1.2 KiB
Org Mode
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

* Adapter parser
This tool parses fastqc reports to extract the adapter sequences, from the *Overrepresented sequences*, and then outputs them to a text file.
** Technologies
- Pandas
** Installation
This project uses [Nix](https://nixos.org/) to ensure reproducible
builds.
1. Install Nix (compatible with MacOS, Linux and
[WSL](https://docs.microsoft.com/en-us/windows/wsl/about)):
#+begin_src bash
curl -L https://nixos.org/nix/install | sh
#+end_src
2. Clone the repository:
#+begin_src bash
git clone https://git.coolneng.duckdns.org/coolneng/adapter-parser
#+end_src
3. Change the working directory to the project:
#+begin_src bash
cd adapter-parser
#+end_src
4. Enter the nix-shell:
#+begin_src bash
nix-shell
#+end_src
After running these commands, you will find yourself in a shell that
contains all the needed dependencies.
** Usage
#+begin_src bash
python src/parser.py -h
#+end_src
#+RESULTS:
:
: \[\] usage: parser.py [-h] input output
:
: positional arguments:
: input directory containing the fastqc reports
: output file where to export the sequences
:
: optional arguments:
: -h, --help show this help message and exit