mm2_install {minimapR}R Documentation

minimap2_install

Description

Install minimap2 from Heng Li's github repository. If using a Windows operating system, installation of the MSYS2 Linux emulator is required.

Usage

mm2_install(source_directory, verbose = TRUE, return = FALSE)

Arguments

source_directory

Source directory to install minimap2. Do not include minimap2 name in the source directory. Note that this must be entered as a full path location.

verbose

Logical value to print progress of the installation

return

This logical value causes the minimap2_install function to return the path of minimap2

Value

If 'minimap2' is not installed, this function installs it on linux and returns the path of the installed 'minimap2' tool (character).

Examples

## Not run: 
install_dir <- file.path("/dir/to/install")
minimap2_path <- mm2_install(source_directory = install_dir, verbose = FALSE)

## End(Not run)

[Package minimapR version 0.0.1.0 Index]