FAQs
Handling data
Also have a look at the code example Loading data.
Q: How do I create an AlphabetContainer instance for DNA sequences?
A: AlphabetContainer container = new AlphabetContainer( new DNAAlphabet() );
Q: Why shall I use the AlphabetContainer and not just a simple Alphabet instance?
A: Because for some data you will not have the same alphabet at each position of the sequence, e.g. when using phenotypic data. Hence, we also strongly recommend to always use getAlphabetLengthAt(int) when setting e.g. the size of an array.
Q: How can I create a simple sequence?
A: Try to use the create method of Sequence, e.q. Sequence.create( new AlphabetContainer( new DNAAlphabet() ), "ACGTACGT" );
Q: How can I load my own data?
A: If your sequences are stored either in plain text or in FastA format, you can directly create a new Sample from the file.
Q: I wrote some sophisticated method using BioJava to load my data from a Genbank file/a database/somewhere else. How can I do something similar in Jstacs?
A: You can still use your existing method. Jstacs has an adapter for BioJava SequenceIterators.
Using existing models
Also have a look at code examples Training a classifier and classifying new sequences, Performing a 10-fold cross validation and Saving and loading a model.
Q: Where do I find a list of the models currently implemented in Jstacs?
A: All generative models in Jstacs implement the Model interface.
All discriminative models in Jstacs implement the ScoringFunction interface. You find all the existing implementations in the list of implementing classes of these two interfaces.
Q: I decided for two Models. How do I learn them and classify new data?
A: You can create a new ModelBasedClassifier from your models and use its train and classify methods. If you only want to learn a model from data, e.g. to sample new sequences, you can also directly use the train method of the Model.
Also see the code example.
Q: I decided for two ScoringFunctions. How do I learn them and classify new data?
A: You can create a new ScoreClassifier from your scoring functions and use its train and classify methods.
Q: I have to decide, which model is best for my classification task. How do I assess different model combinations or classifiers?
A: You can use the subclasses of ClassifierAssessment, e.g. KFoldCrossValidation. All ClassifierAssessments have a constructor that accepts an array of classifiers (or Models). You can then use the assess method to assess these classifiers on the same data using a number of pre-defined performance measures.
Also see the code example
Q: How can store and load my model, classifier, ...?
A: All classes that implement Storable have a method toXML() that returns a StringBuffer containing the instance as XML. Such classes should also have a proper constructor with a single argument StringBuffer. This can be used to create a new instance form a StringBuffer that contains an instance as XML. In addition, the class FileManager allows to read and write StringBuffers to the hard drive.
Also see the code example.
Q: Why does Jstacs use XML to save instances?
A: Because it is human-readable.
Q: I use Gibbs sampling in a class extending AbstractMixtureModel.
- Q1: Why does the sampling create files in temporary directory of Java?
- Q2: Will these files be deleted automatically, if they will not be used any more?
A:
- A1: These files are created for saving the sampled parameter temporarily. Java temp is used to minimize network load if you work on a cluster.
- A2: These files will be deleted if no reference to the mixture instance exists and the Garbage collector is called. Therefore it is recommended to call the Garbage collector explicitly at the end of any application.
Implementing new models
Q: How do I implement a new generative Model?
A: Write an implementation of the Model interface. For convenience, you can use the abstract AbstractModel class with default implementations for many methods.
Also see the code example.
Q: How do I implement a new discriminative model?
A: Write an implementation of the ScoringFunction interface. For convenience, you can use the abstract AbstractNormalizableScoringFunction class with default implementations for many methods.
Q: How do I implement a model that can be trained generatively and discriminatively?
A: You can either extend AbstractModel and additionally implement the ScoringFunction interface, or you extend the AbstractNormalizableScoringFunction and additionally implement the Model interface.
Reporting bugs and requesting new features
Q: How do I report bugs I found in Jstacs?
A: Before reporting bugs in Jstacs, you should be sure it's not a feature ;-) You can discuss potential issues in the Jstacs forum. You can also have a look at the bugs that have already been reported. If you are sure that you found a new bug, please submit a new ticket to the Jstacs bug tracking system.
Q: How can request new features?
A: You may use the Jstacs forum to discuss your request with other users. Most likely, we will join the discussion, too (We are somewhere out there!).
If you are convinced that the feature you request will be useful for all users of Jstacs, you are invited to submit a new ticket with your request.
Other
Q: The class UserTime does not work! Why?
A: The class UserTime uses native code. Therefore there are at least two possibilities:
- A1: You have forgotten to set the Java library path: -Djava.library.path=...
- A2: You have to compile the native code on your system.
