Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cb drafts #21

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/app-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@
[TOC]

### Does Event Data collect data for all DOIs in existence?

Event Data will accept Events for DOIs issued by any Registration Agency (RA) (for example, DataCite), and will poll for all DOIs in the 'doi-prefix' Artifact (currently Crossref, DataCite in future). Different Agents operate differently, so the data for some sources will be fresher than others.

### Which Registration Agencies' DOIs does Event Data use?

Event Data is is a joint venture by Crossref and DataCite. It is able to collect DOIs from any DOI Registration Agency (RA), and most Data Sources don't check which RA a DOI belongs to. So in theory, some MEDRA DOIs might end up being included. However, some Data Sources (such as Twitter) target only Crossref and DataCite DOIs. Check the individual Data Sources for full details.

### How long is Data available?

Once data has entered the Query API it won't be removed (unless under extraordinary circumstances). The data will never 'expire'.

### What is an Event?

An Event can be described as 'an action that occurs concerning a Registered Content Item'. Every kind of event is slightly different, see the Sources for details.
Expand All @@ -24,13 +24,13 @@ All APIs use JSON format

### Do I have to pay for the data?

No, the data available via the Query API is free-of-charge. In the future, we will offer a paid-for Service Level Agreement that will provide more timely access to data.
No, the data available via the Query API is free-of-charge.

### Will the data be auditable?
### Can the data be audited?

Yes. Event Data is evidence-first and we will supply supporting Evidence for all data that we collect. See [Evidence First](concepts/trustworthiness-and-quality/#evidence-first).

### Can I use the data to feed into my commercial tool?
### Can I use the data to feed into my commercial tool?

Yes. We do not clean or aggregate the data we collect so that any commercial vendor has the opportunity to do this themselves in order to use the data in the way which best suits their needs.

Expand All @@ -44,15 +44,15 @@ Check the [Event Data page](https://www.crossref.org/services-event-data) on the

### How do I access the data?

The Query API is currently the only way to access data.
The Query API is currently the only way to access data.

### Does Event Data work with Multiple Resolution?

We plan to address and clarify how Event Data relates to Multiple Resolution in future.

### Does Event Data work with DOIs that include emoticons?

Yes.
Yes.

### Will the API make data available in other formats?

Expand Down
4 changes: 2 additions & 2 deletions docs/app-niso.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ Crossref Event Data reports raw Events, not metrics. The [Sources in Depth](sour

### 3: Describe the method(s) by which data are generated or collected and how data are maintained over time.

The Data Contributors section of the User Guide provides a detailed discussion of each Source and exactly what Events from the Source means.
The Data Contributors section of the User Guide provides a detailed discussion of each Source and exactly what Events from the Source means.

### 4: Describe all known limitations of the data.

The Data Contributors section of the User Guide provides a detailed discussion of each Source and the limits of the data it produces.

### 5: Provide a documented audit trail of how and when data generation and collection methods change over time and list all known effects of these changes. Documentation should note whether changes were applied historically or only from change date forward.

The [Evidence In Depth](evidence-in-depth) section describes the complete audit trail of data, from input to Events, via Evidence Records. It also describes how the Artifact Service shows the complete environment under which an Event was generated. The [Evidence Logs](data/evidence-logs) provide a very high level of detail about every activity and process that took place, including nevative results.
The [Evidence In Depth](evidence-in-depth) section describes the complete audit trail of data, from input to Events, via Evidence Records. It also describes how the Artifact Service shows the complete environment under which an Event was generated. The [Evidence Logs](data/evidence-logs) provide a very high level of detail about every activity and process that took place, including negative results.

### 6: Describe how data are aggregated

Expand Down
19 changes: 8 additions & 11 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,16 @@

Version 1.0.0 - Beta

> UPDATE: **The Event Data Beta service is now functioning normally.** The Percolator stopped processing new data in November, but it is now running, processing new Events, and has re-scanned the problem period.

## A note about Beta

Crossref Event Data has not yet launched as a production service, but is currently available in Beta. This means:
Crossref Event Data has now launched as a production service, but is currently still in Beta. This means:

- **If you have feedback or a specific use case to share, we'd love to hear from you**. You can email [email protected] .
- The Beta service is freely available, but we recommend you contact us to register as a Beta tester so we can keep you in the loop.
- The Beta service isn't feature-complete and there may be funtionality mentioned in this Guide that is not yet implemented.
- We cannot guarantee the stability of the Beta service.
- All data you collect from Event Data during Beta is licensed for public sharing and reuse, according to our [Terms of Use](https://www.crossref.org/services/event-data/terms/). Until Event Data is in production mode though, we do not recommend building any commercial or customer-based tools off the data.
- You may find bugs. If you do, please contact us.
- The Beta service isn't feature-complete and there may be functionality mentioned in this Guide that is not yet implemented.
- All data you collect from Event Data during Beta is licensed for public sharing and reuse, according to our [Terms of Use](https://www.crossref.org/services/event-data/terms/).
- Event Data is now in production mode, this means we do not anticipate making any breaking changes to the code and you are encouraged to build customer facing tools with Event Data.
- As always, it is possible you may find bugs. If you do, please contact us.

## This guide is for everyone

Expand All @@ -23,11 +21,11 @@ This Guide is a living document, and if you have questions or suggestions you ca

## Quick Start

If you're keen to get your hands on the data, you can jump straight to the [Quick Start](https://www.eventdata.crossref.org/guide/service/quickstart/) page. Please bear in mind that the service is in Beta.
If you're keen to get your hands on the data, you can jump straight to the [Quick Start](https://www.eventdata.crossref.org/guide/service/quickstart/) page.

All data collected from Event Data is licensed for public sharing and reuse, according to our [Terms of Use](https://www.crossref.org/services/event-data/terms/). Every Event will include a `license` link so you know which licence applies to the data, as well as a `terms` link which points to our Terms of Use page where all the information and links you need regarding re-use will be available. Please ensure you read the [Terms of Use](https://www.crossref.org/services/event-data/terms/) before using Event Data.
All data collected from Event Data is licensed for public sharing and reuse, according to our [Terms of Use](https://www.crossref.org/services/event-data/terms/). Every Event will include a `license` link so you know which licence applies to the data, as well as a `terms` link which points to our Terms of Use page where all the information and links you need regarding re-use will be available. Please ensure you read the [Terms of Use](https://www.crossref.org/services/event-data/terms/) before using Event Data.

If after the Quick Start you decide to use Event Data, you are strongly encouraged to read the entire Guide. Event Data is an open, flexible service that gathers data from a range of sources. It's important that you understand where the data comes from, how it's processed, and what you should bear in in mind when using it.
If after the Quick Start you decide to use Event Data, you are strongly encouraged to read the entire Guide. Event Data is an open, flexible service that gathers data from a range of sources. It's important that you understand where the data comes from, how it's processed, and what you should bear in in mind when using it.

Click the 'Next' button at the bottom of this page to get started...

Expand All @@ -45,4 +43,3 @@ Click the 'Next' button at the bottom of this page to get started...
| 09-Mar-2017 | 0.7.0 | Joe Wass [email protected] | Complete review of all documentation. Most of it overhauled. |
| 06-May-2017 | 1.0.0 | Joe Wass [email protected] | Beta! |
| 06-May-2017 | 1.0.1 | Joe Wass [email protected] | Add Canonical URLs, Evidence Logs |

18 changes: 9 additions & 9 deletions docs/introduction.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Introduction

Before the growth of the Web, most discussion around scholarly content stayed in scholarly content, with articles referencing each other. With the growth of online platforms for discussion, publication and social media, we have seen discussions occurr in new, non-traditional places.
Before the growth of the Web, most discussion around scholarly content stayed in scholarly content, with articles referencing each other. With the growth of online platforms for discussion, publication and social media, we have seen discussions occur in new, non-traditional places.

The Event Data service captures this activity and acts as a hub for the storage and distribution of this data. The service provides a record of instances where research has been bookmarked, linked, liked, shared, referenced, commented on etc, beyond publisher platforms. For example, when datasets are linked to articles, articles are mentioned on social media or referenced in Wikipedia.

Expand All @@ -10,7 +10,7 @@ When a relationship is observed between a Crossref-Registered Content Item and a

Registered Content is the name we give to items that are registered with Crossref, and to which DOIs have been assigned. This includes Articles, Books and Datasets. When the phrase 'Registered Content Item' is used, you can usually think of a journal article, but be aware that it can apply to any piece of content that was registered with Crossref.

Additionaly, Event Data not only collects this data but also serves as an open platform for third parties to make their own activity data available to everyone. Anyone can build tools, services and research using this platform.
Additionally, Event Data not only collects this data but also serves as an open platform for third parties to make their own activity data available to everyone. Anyone can build tools, services and research using this platform.

<img src='../images/overview.png' alt='Event Data Overview' class='img-responsive'>

Expand Down Expand Up @@ -69,15 +69,15 @@ Every Event starts its journey somewhere, usually in an external source. Data fr

Crossref Event Data was developed alongside the NISO recommendations for Altmetrics Data Quality Code of Conduct, and we participated in the Data Quality working group. Event Data aims to be an example of openness and transparency. You can read the [Event Data Code of Conduct Self-Reporting table](app-niso.md) in the Appendix.

## Accessing the Data
## Accessing the Data

Crossref Event Data is available via our Query API. The Query API allows you to make requests like:

- give me all Events that were collected on 2016-12-08
- give me all Events that occurred on 2015-12-08
- give me all the Reddit Events that were collected on 2015-12-08
- give me all the Events that occurred for this DOI on 2016-01-08
- give me all the Twitter Events that occurred for this DOI on 2016-01-08
- give me all Events that were collected on 2017-12-08
- give me all Events that occurred on 2016-12-08
- give me all the Reddit Events that were collected on 2016-12-08
- give me all the Events that occurred for this DOI on 2017-01-08
- give me all the Twitter Events that occurred for this DOI on 2017-01-08

The Query API allows you to collect Event Data in bulk, to make sure you're up to date.

Expand All @@ -93,4 +93,4 @@ Interpretation is a significant theme in Event Data, and it's something you must

*This feature will be available once Event Data is a production service*

We will introduce a Service Level Agreement which will provide agreed service levels for responsiveness of the service. It will also include APIs for access to data.
We will introduce a Service Level Agreement which will provide agreed service levels. It will also include APIs for access to data.
1 change: 1 addition & 0 deletions wordcount.sh
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# find total word count
find docs | grep '.md' | xargs cat | wc -w