SemanticWeb-Schema/lib/SemanticWeb/Schema/DataCatalog.pm
use utf8;
package SemanticWeb::Schema::DataCatalog;
# ABSTRACT: A collection of datasets.
use v5.14;
use Moo;
extends qw/ SemanticWeb::Schema::CreativeWork /;
use MooX::JSON_LD 'DataCatalog';
use Ref::Util qw/ is_plain_hashref /;
# RECOMMEND PREREQ: Ref::Util::XS
use namespace::autoclean;
our $VERSION = 'v23.0.0';
has dataset => (
is => 'rw',
predicate => '_has_dataset',
json_ld => 'dataset',
);
has measurement_method => (
is => 'rw',
predicate => '_has_measurement_method',
json_ld => 'measurementMethod',
);
has measurement_technique => (
is => 'rw',
predicate => '_has_measurement_technique',
json_ld => 'measurementTechnique',
);
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
SemanticWeb::Schema::DataCatalog - A collection of datasets.
=head1 VERSION
version v23.0.0
=head1 DESCRIPTION
A collection of datasets.
=head1 ATTRIBUTES
=head2 C<dataset>
A dataset contained in this catalog.
A dataset should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::Dataset']>
=back
=head2 C<_has_dataset>
A predicate for the L</dataset> attribute.
=head2 C<measurement_method>
C<measurementMethod>
A subproperty of [[measurementTechnique]] that can be used for specifying specific methods, in particular via L<SemanticWeb::Schema::MeasurementMethodEnum>.
A measurement_method should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::DefinedTerm']>
=item C<InstanceOf['SemanticWeb::Schema::MeasurementMethodEnum']>
=item C<Str>
=back
=head2 C<_has_measurement_method>
A predicate for the L</measurement_method> attribute.
=head2 C<measurement_technique>
C<measurementTechnique>
A technique, method or technology used in an L<SemanticWeb::Schema::Observation>, L<SemanticWeb::Schema::StatisticalVariable> or L<SemanticWeb::Schema::Dataset> (or L<SemanticWeb::Schema::DataDownload>, L<SemanticWeb::Schema::DataCatalog>), corresponding to the method used for measuring the corresponding variable(s) (for datasets, described using [[variableMeasured]]; for L<SemanticWeb::Schema::Observation>, a L<SemanticWeb::Schema::StatisticalVariable>). Often but not necessarily each [[variableMeasured]] will have an explicit representation as (or mapping to) an property such as those defined in Schema.org, or other RDF vocabularies and "knowledge graphs". In that case the subproperty of [[variableMeasured]] called [[measuredProperty]] is applicable.
The [[measurementTechnique]] property helps when extra clarification is needed about how a [[measuredProperty]] was measured. This is oriented towards scientific and scholarly dataset publication but may have broader applicability; it is not intended as a full representation of measurement, but can often serve as a high level summary for dataset discovery.
For example, if [[variableMeasured]] is: molecule concentration, [[measurementTechnique]] could be: "mass spectrometry" or "nmr spectroscopy" or "colorimetry" or "immunofluorescence". If the [[variableMeasured]] is "depression rating", the [[measurementTechnique]] could be "Zung Scale" or "HAM-D" or "Beck Depression Inventory".
If there are several [[variableMeasured]] properties recorded for some given data object, use a L<SemanticWeb::Schema::PropertyValue> for each [[variableMeasured]] and attach the corresponding [[measurementTechnique]]. The value can also be from an enumeration, organized as a L<SemanticWeb::Schema::MeasurementMetholdEnumeration>.
A measurement_technique should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::DefinedTerm']>
=item C<InstanceOf['SemanticWeb::Schema::MeasurementMethodEnum']>
=item C<Str>
=back
=head2 C<_has_measurement_technique>
A predicate for the L</measurement_technique> attribute.
=head1 SEE ALSO
L<SemanticWeb::Schema::CreativeWork>
=head1 SOURCE
The development version is on github at L<https://github.com/robrwo/SemanticWeb-Schema>
and may be cloned from L<git://github.com/robrwo/SemanticWeb-Schema.git>
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website
L<https://github.com/robrwo/SemanticWeb-Schema/issues>
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
=head1 AUTHOR
Robert Rothenberg <rrwo@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2018-2023 by Robert Rothenberg.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)
=cut