Skip to content

Commit de66ca9

Browse files
committed
review example
1 parent a9fa0b8 commit de66ca9

File tree

11 files changed

+28
-2707
lines changed

11 files changed

+28
-2707
lines changed

README.md

Lines changed: 3 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,6 @@ The following metadata can be repeated and could follow a controlled vocabulary.
7979

8080
- Author: name or ORCID
8181
- Organization: name or URL
82-
- Editor: name or URL
8382
- Journal: name or URL
8483
- Datacenter that provides the result: name or URL
8584
- Contact: email
@@ -115,7 +114,6 @@ For queries on evolving dataset, the version or the date must complete the infor
115114
|version | Dataset version (or release date) | |
116115
|service_protocol| Protcol access with version | |
117116
|request| Request url  | |
118-
|request_post| (POST Request) POST arguments **new**  | |
119117
|request_date| Query execution date | |
120118
|contact| email or URL contact | |
121119
|landing_page| Dataset landing page | |
@@ -133,12 +131,11 @@ Dataset-origin completes the "Query information" -
133131
|Publication-id| Dataset identifier that can be used for citation | yes |
134132
|Curation-level| Controled vocabulary | |
135133
|Resource-version| Dataset version od last release | |
136-
|Rights| Licence URI | |
137-
|Rights-type| Licence type (eg: CC-by, CC-0, private, public) | |
138-
|Copyrights| Copyright text | |
134+
|Rights_URI| Licence URI | |
135+
|Rights| Licence type (eg: CC-by, CC-0, private, public) or copyrights| |
139136
|Creator| Dataset Author(s) or group | |
140137
|Publication-ref| Identifier of the original resource that can be an article or the origin Data Center|
141-
|Editor| editor name| |
138+
|Journal or Editor| journal or editor name| |
142139
|Relation_type | controled vocabulary (VOResource: relationshipType ? ) to specify relation to related resource **new**|
143140
|related_resource | Original resource **new**|
144141
|Publication-date| Date of the original publication | |
@@ -152,33 +149,6 @@ eg: bibcode:...,
152149
Serialisation example: &lt;info&gt; tag makes the jobs. see <a href='tests/J_AJ_161_36_table8.xml'>SCS example</a>
153150

154151

155-
- Complex output involving **several tables** (eg: TAP query, ObsCore result)
156-
157-
Dataset-origin depends on each table used for the output. Datamodels like Last-step -Provenance or DatasetDM allows to gather the metadata.
158-
159-
DatasetDM Example:
160-
161-
|meta-data| Description| Mandatory |
162-
|--- |:-: |:-: |
163-
|dataset:productType|||
164-
|dataset:productSubType| controled vocabulary||
165-
|dataset:DataID.datasetDID| dataset ivoid|yes|
166-
|dataset:DataID.title| dataset title||
167-
|dataset:DataID.creationType| type of resource ||
168-
|dataset:DataID.date| Publication date of original dataset/article||
169-
|dataset:Party.name| (first)Author | |
170-
|dataset:Curation.publisherDID| data-center identifier (ivoid)|yes|
171-
|dataset:Curation.rights| rights text| |
172-
|dataset:Curation.releaseDate| Data-center publication date|yes|
173-
|party.Organisation.email|Data-center contact||
174-
|dataset:Curation.doi| Dataset DOI| |
175-
|dataset:Curation.bibcode| Dataset bibcode||
176-
177-
Serialisation example: DatasetDM serialisation. see <a href='tests/tap.xml'>TAP example</a>
178-
179-
(see also: <a href='https://wiki.ivoa.net/twiki/pub/IVOA/InterOpOct2022DM/IVOA-DMTAP-VizieR.pdf'>datasetDM in TAP (ivoa-talk)</a>
180-
181-
182152

183153
# About
184154
This document describes simple means to declare basic provenance

data-origin.tex

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -176,18 +176,22 @@ \subsection{Data Origin in IVOA Registry}
176176
\subsection{Data Origin and Provenance}
177177
%The Provenance \citep{2020ivoa.spec.0411S} and Dataset Data Models can
178178
%be used to express Data Origin.
179+
Data origins information is intended to be provided in the results of queries. This information can be used to populate steps in a Provenance workflow.
179180

180-
The Provenance Data Model \citep{2020ivoa.spec.0411S} is based on Entities, Agents and Activities as defined in the W3C Provenance model. The model's main focus is the detailed documentation of workflows.
181+
Dataset Origin (see \ref{sec:dataset-origin}) can be serialized with Entities and Agent. The query information including information such as URL and parameters (see \ref{sec:query-information}) can be set with the configuration extension of the Provenance DM of the Virtual Observatory \citep{2020ivoa.spec.0411S}.
181182

182-
For the serialisation of ProvDM instances within VOTables, MIVOT \citep{2023ivoa.spec.0620M} is available. At this point, however, the relatively complex model and many free parameters are obstacles for a wide and direct adoption of ProvDM+MIVOT to represent Data Origin, in particular when compared to the very straightforward mechanisms proposed here.
183+
184+
%The Provenance Data Model \citep{2020ivoa.spec.0411S} is based on Entities, Agents and Activities as defined in the W3C Provenance model. The model's main focus is the detailed documentation of workflows.
185+
186+
%For the serialisation of ProvDM instances within VOTables, MIVOT \citep{2023ivoa.spec.0620M} is available. At this point, however, the relatively complex model and many free parameters are obstacles for a wide and direct adoption of ProvDM+MIVOT to represent Data Origin, in particular when compared to the very straightforward mechanisms proposed here.
183187

184188

185189
%``Last-Step-Provenance'' is a Provenance extension currently under discussion which would define a list of metadata corresponding to Data Origin. Its output will not be recursive and could be easily serialized in a table.\todo{If we write this here, everyone will ask: Well, so why don't we wait for that? Perhaps we ought to just drop this?}
186-
Other initiatives, in working progress, such as ``DatasetDM'', or
187-
``Last-Step-Provenance'' show the growing interest of adding pieces of
188-
provenance to published datasets.
189-
The metadata listed in Data Origin can be a reference for current
190-
and future models interested by the information.
190+
%Other initiatives, in working progress, such as ``DatasetDM'', or
191+
%``Last-Step-Provenance'' show the growing interest of adding pieces of
192+
%provenance to published datasets.
193+
%The metadata listed in Data Origin can be a reference for current
194+
%and future models interested by the information.
191195

192196
\subsection{DALI}
193197
DALI \citep{2017ivoa.spec.0517D} defines common conventions for all
@@ -239,6 +243,7 @@ \section{Data Origin in VOTable}
239243

240244

241245
\subsection{Query information}
246+
\label{sec:query-information}
242247
Table~\ref{tab:query-names} lists the metadata items defined here to
243248
convey query-related information in Data Origin.
244249

@@ -256,16 +261,16 @@ \subsection{Query information}
256261
publisher & Data centre that produced the VOTable & publisher\\ \hline
257262
%rename 23-nov-2023 version & Software version (*) & & \\ \hline
258263
server\_software & Software version (*) & \\ \hline
259-
service\_protocol & IVOID of the protocol through which the data was
260-
retrieved & \\ \hline
264+
service\_protocol & IVOID of the protocol through which the data was retrieved & \\ \hline
265+
service\_ivoid & IVOID of the service through which the data was retrieved & \\ \hline
261266
request & Full request URL including a query string (**)& \\ \hline
262267
query & An input query in a formal language (e.g., ADQL) & \\ \hline
263268
% removed in 23-nov-2023
264269
%request\_post & (POST Request) POST arguments & & \\ \hline
265270
% end
266271
request\_date & Query execution date &\\ \hline
267272
contact & Email or URL to contact publisher & \\ \hline
268-
ivoid\_service & IVOID of the service through which the data was retrieved & \\ \hline
273+
269274
\multicolumn{3}{p{\textwidth}}{\vskip 2pt\footnotesize(*) Operators are
270275
encouraged to follow \citet{note:opid} in this item.} \\
271276
\multicolumn{3}{p{\textwidth}}{\footnotesize(**) For ``Simple''
@@ -283,6 +288,7 @@ \subsection{Query information}
283288

284289

285290
\subsection{Dataset Origin}
291+
\label{sec:dataset-origin}
286292
Dataset origin complements the query-related information to improve the
287293
understandability of the underlying data. Clients should make
288294
sure that end users can easily access and inspect this information.
@@ -299,7 +305,8 @@ \subsection{Dataset Origin}
299305
\begin{tabular}{|l|>{\raggedright}p{7cm}|l|} \hline
300306
\textbf{\vrule width0pt height 12pt depth 7pt Key} & \textbf{Description} & \textbf{Dublin Core}\\ \hline
301307
% removed 23-nov-2023 publication\_id & Dataset identifier that can be used for citation& M & identifier\\ \hline
302-
ivoid & IVOID of underlying data collection & \\ \hline
308+
data\_ivoid & IVOID of underlying data collection & \\ \hline
309+
ivoid & (deprecated) use data\_ivoid & \\ \hline
303310
citation & Dataset identifier that can be used for citation (e.g. dataset DOI) & identifier\\ \hline
304311
reference\_url & Dataset landing page & \\ \hline % previously landing_page
305312
% removed in 23-nov-2023
@@ -315,8 +322,8 @@ \subsection{Dataset Origin}
315322
rights & Licence or Copyright text & rights\\ \hline
316323
creator & \raggedright The person(s) mainly involved in the
317324
creation of the resource; generally, the author(s)
318-
& creator\\ \hline
319-
editor & Designation of the medium the originating scholarly publication was
325+
& creator\\ \hline
326+
journal & Designation of the medium the originating scholarly publication was
320327
published in. In general, that is a journal name. Common
321328
abbreviations (ApJ, A\&A, \dots) are encouraged. & \\ \hline
322329
% removed 15-dec-2023 to use cites or is_derived_from
@@ -405,7 +412,7 @@ \section{Appendix, Cone search serialization}\label{sec:appendixA}
405412
<RESOURCE ID="yCat_51610036" name="J/AJ/161/36">
406413
<DESCRIPTION>117 exoplanets in habitable zone with Kepler DR25</DESCRIPTION>
407414

408-
<INFO name="ivoid" value="ivo://cds.vizier/j/aj/161/36">
415+
<INFO name="data_ivoid" value="ivo://cds.vizier/j/aj/161/36">
409416
ivoid identifier to link registry
410417
</INFO>
411418
<INFO name="publisher" value="CDS">data centre</INFO>
@@ -423,7 +430,7 @@ \section{Appendix, Cone search serialization}\label{sec:appendixA}
423430
<INFO name="cites" value="2021AJ....161...36B">
424431
Reference article
425432
</INFO>
426-
<INFO name="editor" value="Astronomical Journal">
433+
<INFO name="journal" value="AJ">
427434
Journal of the reference article
428435
</INFO>
429436
<INFO name="publication_date" value="2021-03-16">
@@ -577,8 +584,9 @@ \section{Appendix, Changes from Previous Versions}
577584
%\subsection{Data Origin in the VO Version 1.0}
578585
\subsection{Difference between versions 1.1 and 1.2}
579586
\begin{itemize}
580-
\item New item: \textit{ivoid\_service}
581-
\item Move ivoid from Table1 (query) to Table2 (Origin)
587+
\item New item: \textit{service\_ivoid}
588+
\item Rename ivoid to data\_ivoid (now in Table2 (Origin))
589+
\item Rename editor to journal
582590
\end{itemize}
583591

584592
\subsection{Difference between versions 1.0 and 1.1}

reports/schema-doi.png

-322 KB
Binary file not shown.

tests/J_AJ_161_36_table8.xml

Lines changed: 0 additions & 128 deletions
This file was deleted.

tests/README.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

0 commit comments

Comments
 (0)