Overview

Namespaces

  • AnalyseModule
    • Models
  • BaseModule
    • Exceptions
    • Models
    • Repository
    • Services
  • DispatchModule
    • Helpers
    • Models
    • Tools
  • PredictModule
  • SearchModule

Classes

  • RnaplotHelper
  • TravelerHelper
  • Overview
  • Namespace
  • Class

Class TravelerHelper

TravelerHelper handles generation of svg visualizations of predicted structures using Traveler

Namespace: DispatchModule\Helpers
Located at DispatchModule/helpers/TravelerHelper.php
Methods summary
public static
# deleteTravelerFiles( string $travelerTemp, integer $maxfiles )

Deletes all traveler svg files - if there's more than maximum limit (see maxTravelerSvgStored in config)

Deletes all traveler svg files - if there's more than maximum limit (see maxTravelerSvgStored in config)

Parameters

$travelerTemp
path to traveler temporary dir
$maxfiles
maximum ammount of files to keep or -1 for infinity
public static
# generateTraveler( string $travelerTemp, string $idString, string $sequence, string $prediction, integer $maxfiles = 200 )

Genereates Traveler svg file

Genereates Traveler svg file

Parameters

$travelerTemp
path to traveler temporary dir
$idString
svg name
$sequence
whole sequence
$prediction
predicted structure in dot-parent notation
$maxfiles
max svg files to keep in temporary storage (-1 for infinity)

Throws

BaseModule\Exceptions\BaseException
API documentation generated by ApiGen