bcgov / bcdata

An R package for searching & retrieving data from the B.C. Data Catalogue
https://bcgov.github.io/bcdata
Apache License 2.0
81 stars 12 forks source link

Data Citations #273

Closed boshek closed 2 years ago

boshek commented 3 years ago

It would be nice to provide a convenience function for individuals to cite a specific dataset. We can iterate exactly what but something like:

bcdc_get_data_citation("bc-airports")

which then would return something like:

Data source: B.C. Data Catalogue https://catalogue.data.gov.bc.ca/dataset/bc-airports

annikaLiving commented 3 years ago

Recommend always using the permalink and not the title url as titles change. Which uses the dataset ID or can find it with the Show the Permalink button on the UI (tho easier to right click and copy url).

This is for BC Airports. https://catalogue.data.gov.bc.ca/dataset/76b1b7a3-2112-4444-857a-afccf7b20da8

annikaLiving commented 3 years ago

@boshek thought i should add for open data

https://www2.gov.bc.ca/gov/content?id=A519A56BC2BF44E4A008B33FCF527F61

You are free to:

  1. Copy, modify, publish, translate, adapt, distribute or otherwise use the Information in any medium, mode or format for any lawful purpose.

You must, where you do any of the above:

  1. Acknowledge the source of the Information by including any attribution statement specified by the Information Provider(s) and, where possible, provide a link to this licence. If the Information Provider does not provide a specific attribution statement, or if you are using Information from several Information Providers and multiple attributions are not practical for your product or application, you must use the following attribution statement:

Contains information licensed under the Open Government Licence – British Columbia.

boshek commented 3 years ago

So then with the airports example, we'd provide something like:

Data source: https://catalogue.data.gov.bc.ca/dataset/76b1b7a3-2112-4444-857a-afccf7b20da8 Licensed under the Open Government Licence - British Columbia: https://www2.gov.bc.ca/gov/content?id=A519A56BC2BF44E4A008B33FCF527F61

For something that isn't the BC licence:

Data source: https://catalogue.data.gov.bc.ca/dataset/a7627a6a-9b36-489b-ae58-edf2620083c6 Licensed under the Statistics Canada Open Licence: https://www.statcan.gc.ca/eng/reference/licence

How does that look? The record endpoint returns all this stuff very nicely 😄

annikaLiving commented 3 years ago

@boshek one piece that i think is missing from the policy/licence is to include always refer back to the record to confirm licencing, as at times they can change, especially those that were "Access Only" and changed to Open Government Licence - British Columbia.

Speaking about "Access Only" it is noted in the Crown Copyright page. https://www2.gov.bc.ca/gov/content?id=1AAACC9C65754E4D89A118B875E0FBDA

stephhazlitt commented 3 years ago

I think returning the current licence is sufficient due diligence here. If someone uses bcdc_get_data_citation("bc-airports") in a report that is published to a static medium (e.g. journal, PDF), the citation will be relevant to that date-stamped report. If a reader subsequently uses the citation to navigate to the data for further use, then any change in licence would apply at that time.

What about the human-readbale record name, with the permalink URL, licence and access date?

e.g.,

Data source: British Columbia Data Catalogue—BC Airports (https://catalogue.data.gov.bc.ca/dataset/76b1b7a3-2112-4444-857a-afccf7b20da8), Open Government Licence - British Columbia (https://www2.gov.bc.ca/gov/content?id=A519A56BC2BF44E4A008B33FCF527F61), accessed on 2021-05-11.

boshek commented 2 years ago

Potential here to leverage R's bibtex class:

rref <- bibentry(
   bibtype = "Manual",
   title = "R: A Language and Environment for Statistical Computing",
   author = person("R Core Team"),
   organization = "R Foundation for Statistical Computing",
   address = "Vienna, Austria",
   year = 2014,
   url = "https://www.R-project.org/")
ateucher commented 2 years ago

Love this. Definitely think we need the access date and the license

boshek commented 2 years ago

Will hold off working on this until #282 is merged though