magpie.utility.interfaces

Interface Citable

All Known Implementing Classes:

AbstractNonlinearRegression, AbstractParsedNonlinearRegression, APRDFAttributeGenerator, BaseClassifier, BaseModel, BaseRegression, ChargeDependentAttributeGenerator, ClassificationRegression, CompositeRegression, CompositionDataset, CoulombEwaldMatrixRegression, CoulombMatrixAttributeGenerator, CoulombSineMatrixRegression, CrystalStructureDataset, CumulantExpansionClassifier, Dataset, ElementDataset, FunctionExpander, GuessMeanRegression, IonicityAttributeGenerator, LassoAttributeSelector, LASSORegression, LinearCorrectedRegression, MeredigAttributeGenerator, MetallurgicalHeuristicRegression, MixingRuleRegression, MultiObjectiveRegression, MultiPropertyDataset, MultiPropertyRegression, NonlinearRegressionExpr, PolynomialRegression, PRDFAttributeGenerator, PRDFRegression, PrototypeDataset, RandomGuessRegression, ScikitLearnClassifier, ScikitLearnRegression, SimpleLinearModelExample, SingleGuessRegression, SplitClassifier, SplitModel, SplitRegression, StagedAttributeSelector, StagedRegression, StoichiometricAttributeGenerator, StructureKRRBasedRegression, ValenceShellAttributeGenerator, WekaClassifier, WekaRegression, YangOmegaAttributeGenerator

public interface Citable

Interface for objects that should be referenced if they are used.

Users need two pieces of information before citing a resource:

1. Why this resources is being cited
2. Where to find the resource

For that reason, each citation is provided along with a short description of what that resource contains, which should justify why it should be cited.

Some objects may require several distinct citations or composed of several other objects (ex: a Dataset may have several BaseAttributeGenerator). For that reason, the getCitations() commands returns a list of citations. Those from a subcomponent should be listed last.

For example, a CompositionDataset that uses ValenceShellAttributeGenerator should cite the paper by Meredig et al. where these attributes were first used. Therefore, it should include the citation:

Reason: Introduced using the fraction of electrons in each valence shell of the constituent elements as attributes.
Citation: ValenceShellAttributeGenerator. B. Meredig, A. Agrawal, et al. "Combinatorial screening for new materials in unconstrained composition space with machine learning". http://link.aps.org/doi/10.1103/PhysRevB.89.094104.

Method Summary

Modifier and Type	Method and Description
java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.String,Citation>>	getCitations() Return a list of citations for this object and any underlying objects.

Method Detail

getCitations

java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.String,Citation>> getCitations()

Return a list of citations for this object and any underlying objects.

Returns:

List of pairs: [Reason for Citation], [Citation]