create_license: Create License and Intellectual Rights

View source: R/intellectual-rights-element.R

create_licenseR Documentation

Create License and Intellectual Rights

Description

Creates the intellectual rights information of a dataset based off of EML standards.

Usage

create_license(
  default_license = c("CCO", "CCBY"),
  license_name = NULL,
  license_url = NULL,
  license_identifier = NULL,
  intellectual_rights_descripiton = NULL
)

Arguments

default_license

Use "CCO" or "CCBY" as argument value to use one of the CVPIA default licenses. Supply NULL if using another license.

license_name

(Optional) if using default_license = "CCO" or "CCBY" as default values are provided. Otherwise, please provide the appropriate license name. Other possible license examples include "MIT License" and "Creative Commons Attribution Non Commercial Share Alike 4.0 International".

license_url

(Optional) if using default_license = "CCO" or "CCBY" as default values are provided. Otherwise, please provide the correct license url to view further license information.

license_identifier

(Optional) if using default_license = "CCO" or "CCBY" as default values are provided. Otherwise, please provide the appropriate identifier. Other possible identifiers include "MIT" and "CC-BY-NC-SA".

intellectual_rights_descripiton

(Optional) if using default_license = "CCO" or "CCBY" as default values are provided. Otherwise, please provide a short description of the license being used and its regulations.

Details

Learn more about the default CVPIA licese options from Creative Commons:

  • CCO - The most premissive license, appropriate for data in the public domain.

  • CC BY - Attribution required

To understand the difference between license choice or to use another Creative Commons license this wikipedia page is helpful.

To view more license choices and find the appropriate url and identifier visit this link.

Value

A intellectual rights element that can be appended to a dataset or project list.

Examples

create_license() # defaults to CCO

create_license(default_license = "CCBY")

create_license(default_license = NULL, 
           license_name = "Creative Commons Attribution Non Commercial Share Alike 4.0 International", 
           license_url = "https://spdx.org/licenses/CC-BY-NC-SA-4.0.html", 
           license_identifier = "CC-BY-NC-SA-4.0", 
           intellectual_rights_descripiton = "This information is released under 
           the Creative Commons license - Attribution - CC BY-NC-SA 
           (https://creativecommons.org/licenses/by-nc-sa/4.0/). The consumer 
           of these data (\"Data User\" herein) is required to cite it 
           appropriately in any publication that results from its use. 
           The Data User should realize that these data may be actively 
           used by others for ongoing research and that coordination may be 
           necessary to prevent duplicate publication. The Data User is urged 
           to contact the authors of these data if any questions about 
           methodology or results occur. Where appropriate, the Data User is 
           encouraged to consider collaboration or co-authorship with the authors. 
           The Data User should realize that misinterpretation of data may occur 
           if used out of context of the original study. While substantial efforts 
           are made to ensure the accuracy of data and associated documentation, 
           complete accuracy of data sets cannot be guaranteed. All data are made 
           available \"as is.\" The Data User should be aware, however, that 
           data are updated periodically and it is the responsibility of the
           Data User to check for new versions of the data. The data authors and
           the repository where these data were obtained shall not be liable for 
           damages resulting from any use or misinterpretation of the data. 
           You may not use the material for commercial purposes and you must 
           distribute your contributions on this same license. Thank you.
")


CVPIA-OSC/EMLaide documentation built on Aug. 25, 2023, 8:53 a.m.