net.maizegenetics.analysis.data.PlinkLoadPlugin Maven / Gradle / Ivy

/*
 * PlinkLoadPlugin.java
 *
 * Created on December 18, 2009
 *
 */
package net.maizegenetics.analysis.data;

import net.maizegenetics.dna.snp.GenotypeTable;
import net.maizegenetics.dna.snp.ImportUtils;

import net.maizegenetics.plugindef.AbstractPlugin;
import net.maizegenetics.plugindef.DataSet;
import net.maizegenetics.plugindef.Datum;
import net.maizegenetics.plugindef.PluginEvent;
import net.maizegenetics.plugindef.PluginParameter;
import net.maizegenetics.util.Utils;

import javax.swing.*;

import java.awt.Frame;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

/**
 *
 * @author Terry Casstevens
 */
public class PlinkLoadPlugin extends AbstractPlugin {

    private static final Logger myLogger = LogManager.getLogger(PlinkLoadPlugin.class);

    private PluginParameter myPedFile = new PluginParameter.Builder<>("pedFile", null, String.class).required(true).inFile()
            .description("Ped File").build();
    private PluginParameter myMapFile = new PluginParameter.Builder<>("mapFile", null, String.class).required(true).inFile()
            .description("Map File").build();
    private PluginParameter mySortPositions = new PluginParameter.Builder<>("sortPositions", false, Boolean.class)
            .description("Whether to sort genotype positions.")
            .build();

    /**
     * Creates a new instance of PlinkLoadPlugin
     */
    public PlinkLoadPlugin(Frame parentFrame, boolean isInteractive) {
        super(parentFrame, isInteractive);
    }

    @Override
    public DataSet processData(DataSet input) {
        return loadFile(pedFile(), mapFile(), sortPositions());
    }

    /**
     * Convenience method to run plugin with one return object.
     */
    public GenotypeTable runPlugin(DataSet input) {
        return (GenotypeTable) performFunction(input).getData(0).getData();
    }

    /**
     * Ped File
     *
     * @return Ped File
     */
    public String pedFile() {
        return myPedFile.value();
    }

    /**
     * Set Ped File. Ped File
     *
     * @param value Ped File
     *
     * @return this plugin
     */
    public PlinkLoadPlugin pedFile(String value) {
        myPedFile = new PluginParameter<>(myPedFile, value);
        return this;
    }

    /**
     * Map File
     *
     * @return Map File
     */
    public String mapFile() {
        return myMapFile.value();
    }

    /**
     * Set Map File. Map File
     *
     * @param value Map File
     *
     * @return this plugin
     */
    public PlinkLoadPlugin mapFile(String value) {
        myMapFile = new PluginParameter<>(myMapFile, value);
        return this;
    }

    /**
     * Whether to sort genotype positions.
     *
     * @return Sort Positions
     */
    public Boolean sortPositions() {
        return mySortPositions.value();
    }

    /**
     * Set Sort Positions. Whether to sort genotype positions.
     *
     * @param value Sort Positions
     *
     * @return this plugin
     */
    public PlinkLoadPlugin sortPositions(Boolean value) {
        mySortPositions = new PluginParameter<>(mySortPositions, value);
        return this;
    }

    /**
     * Icon for this plugin to be used in buttons, etc.
     *
     * @return ImageIcon
     */
    public ImageIcon getIcon() {
        return null;
    }

    /**
     * Button name for this plugin to be used in buttons, etc.
     *
     * @return String
     */
    public String getButtonName() {
        return "Load Plink";
    }

    /**
     * Tool Tip Text for this plugin
     *
     * @return String
     */
    public String getToolTipText() {
        return "Load Plink Files";
    }

    private DataSet loadFile(String thePedFile, String theMapFile, boolean sortPositions) {

        GenotypeTable result = ImportUtils.readFromPLink(thePedFile, theMapFile, this, sortPositions);
        Datum td = new Datum(Utils.getFilename(thePedFile, FileLoadPlugin.FILE_EXT_PLINK_PED), result, null);
        DataSet tds = new DataSet(td, this);
        fireDataSetReturned(new PluginEvent(tds, PlinkLoadPlugin.class));

        return tds;

    }

}