Interface DataLoader
- All Superinterfaces:
AutoCloseable,Closeable
- All Known Subinterfaces:
SequencingDataLoader,SingleCellDataLoader
- All Known Implementing Classes:
AbstractDelegatingDataLoader,AbstractDelegatingSequencingDataLoader,AbstractDelegatingSingleCellDataLoader,AnnDataSingleCellDataLoader,GenericMetadataSingleCellDataLoader,MexSingleCellDataLoader,NullSingleCellDataLoader,SequencingMetadataFileDataLoader,SequencingMetadataFileSingleCellDataLoader
Base interface for loading expression data in Gemma.
- Author:
- poirigui
-
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Free any resources that the loaded has setup.getFactors(Collection<BioAssay> samples, Map<BioMaterial, Set<FactorValue>> factorValueAssignments) Load experimental factors present in the data.getGenes()Load gene identifiers present in the data.Load quantitation types present in the data.Obtain the sample names present in the data.getSamplesCharacteristics(Collection<BioAssay> samples) Load samples characteristics present in the data.voidsetBioAssayToSampleNameMapper(BioAssayMapper bioAssayToSampleNameMatcher) Set the strategy used for mappingBioAssayto sample names from the data.voidsetDesignElementToGeneMapper(DesignElementMapper designElementToGeneMapper) Set the strategy used for mappingCompositeSequenceto gene identifiers from the data.voidsetIgnoreUnmatchedDesignElements(boolean ignoreUnmatchedDesignElements) Ignore unmatched design elements from the data when creating vectors.voidsetIgnoreUnmatchedSamples(boolean ignoreUnmatchedSamples) Ignore unmatched samples from the data.
-
Method Details
-
setBioAssayToSampleNameMapper
Set the strategy used for mappingBioAssayto sample names from the data. -
setIgnoreUnmatchedSamples
void setIgnoreUnmatchedSamples(boolean ignoreUnmatchedSamples) Ignore unmatched samples from the data.This defaults to true.
-
setDesignElementToGeneMapper
Set the strategy used for mappingCompositeSequenceto gene identifiers from the data. -
setIgnoreUnmatchedDesignElements
void setIgnoreUnmatchedDesignElements(boolean ignoreUnmatchedDesignElements) Ignore unmatched design elements from the data when creating vectors.This defaults to true.
There's a discussions to make this default in false in general for sequencing data.
-
getSampleNames
Obtain the sample names present in the data.- Throws:
IOException
-
getQuantitationTypes
Load quantitation types present in the data.- Throws:
IOException
-
getFactors
Set<ExperimentalFactor> getFactors(Collection<BioAssay> samples, @Nullable Map<BioMaterial, Set<FactorValue>> factorValueAssignments) throws IOExceptionLoad experimental factors present in the data.- Parameters:
samples- samples to use when determining which factors to loadfactorValueAssignments- if non-null, the proposed assignment of factor values to samples are populated in the mapping.- Returns:
- a set of factors present in the data
- Throws:
IOException
-
getSamplesCharacteristics
Map<BioMaterial,Set<Characteristic>> getSamplesCharacteristics(Collection<BioAssay> samples) throws IOException Load samples characteristics present in the data.- Parameters:
samples- to use when determining which characteristics to load- Returns:
- proposed characteristics grouped by sample
- Throws:
IOException
-
getGenes
Load gene identifiers present in the data.- Throws:
IOException
-
close
Free any resources that the loaded has setup.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Throws:
IOException
-