USGCRP / gcis-conventions

Repository for the collection, management, and versioning of the GCIS data management conventions.
https://usgcrp.github.io/gcis-conventions/
1 stars 0 forks source link

Journal Convention Discussion #26

Closed lomky closed 6 years ago

lomky commented 6 years ago

A ticket to discuss the conventions surrounding Journals.

Current Journal Conventions. (none)

Journal Fields:

gcis=# \d+ journal
                                                                  Table "gcis_metadata.journal"
   Column    |       Type        | Modifiers | Storage  | Stats target |                                       Description
-------------+-------------------+-----------+----------+--------------+------------------------------------------------------------------------------------------
 identifier  | character varying | not null  | extended |              | A descriptive identifier for this journal.
 title       | character varying |           | extended |              | The title of the journal (source: crossref.org)
 publisher   | character varying |           | extended |              | DEPRECATED - use Contributor relationship, role Publisher, to the publisher Organization
 country     | character varying |           | extended |              | The country of publication.
 url         | character varying |           | extended |              | A URL for the landing page for this journal.
 notes       | character varying |           | extended |              |
 print_issn  | issn              |           | plain    |              |
 online_issn | issn              |           | plain    |              |
Indexes:
    "journal_pkey" PRIMARY KEY, btree (identifier)
    "journal_new_online_issn_key" UNIQUE CONSTRAINT, btree (online_issn)
    "journal_new_print_issn_key" UNIQUE CONSTRAINT, btree (print_issn)
Check constraints:
    "ck_journal_identifier" CHECK (identifier::text ~ similar_escape('[a-z0-9_-]+'::text, NULL::text))
    "has_issn" CHECK (print_issn IS NOT NULL OR online_issn IS NOT NULL)
Referenced by:
    TABLE "article" CONSTRAINT "article_ibfk_1" FOREIGN KEY (journal_identifier) REFERENCES journal(identifier) ON UPDATE CASCADE ON DELETE CASCADE
Triggers:
    audit_trigger_row AFTER INSERT OR DELETE OR UPDATE ON journal FOR EACH ROW EXECUTE PROCEDURE audit.if_modified_func('true')
    audit_trigger_stm AFTER TRUNCATE ON journal FOR EACH STATEMENT EXECUTE PROCEDURE audit.if_modified_func('true')
    delpub BEFORE DELETE ON journal FOR EACH ROW EXECUTE PROCEDURE delete_publication()
    updatepub BEFORE UPDATE ON journal FOR EACH ROW WHEN (new.identifier::text <> old.identifier::text) EXECUTE PROCEDURE update_publication()

Provenance Connections: None.

Relationships:

Articles
Contributors
gcmd_keywords
regions
lomky commented 6 years ago

Field Breakdown

identifier

This is based on the title.
When creating a journal, leave the identifier blank such that the system autocreates it without the articles.

Current Definition:

A descriptive identifier for this journal.

title

The title according to crossref.
Fallback to the title on the website or best available source.

Current Definition:

The title of the journal (source: crossref.org)

publisher

Deprecated.

Current Definition:

DEPRECATED - use Contributor relationship, role Publisher, to the publisher Organization

country

Optional. If filled in, use the country codes as they appear in our Countries table.
Fill in if this improves clarity.

Current Definition:

The country of publication.

url

Current Definition:

Strongly want this filled in.
Can be left blank if no such url is available.

For defunct journals, point to the official archive website, if any.

A URL for the landing page for this journal.

notes

Currently used to capture the provenance connection we can't capture semantically.
No other good use. Do not use.

Todo: Should we display these?

Current Definition:

print_issn

We want to have at least one of the ISSNs.
If there is more than one, use the first listed & functional ISSN.

Current Definition:

online_issn

We want to have at least one of the ISSNs.
If there is more than one, use the first listed & functional ISSN.

Current Definition:

Provenance

We are debating the merits of a provenance connection between related journals (i.e. defunct & successor).

Relationships

Article

Contributors

Files

An exemplar image of an issue of the Journal, pulled from their website.

gcmd_keywords

Not used on this object.

regions

Not yet implemented.

lomky commented 6 years ago

Metrics

5 issn + title + url + country/notes issn + issn + title + url

4 issn + title + url issn + title + publisher rel url + title + publisher rel

3 issn + title url + title

2 title + country title + publisher rel issn url

1

lomky commented 6 years ago

Notes Done. Please review!

lomky commented 6 years ago

Updated.