swirlify (version 0.5.3)

add_license: Add a LICENSE.txt file to your course

Description

Licensing your course is important if you want to share your course. For more information see https://github.com/swirldev/swirlify/wiki/Licensing-Your-Course. For more information about Creative Commons licenses see http://creativecommons.org/licenses/. For more information about software licenses see http://www.gnu.org/licenses/license-list.en.html.

Usage

add_license(author, year = format(Sys.Date(), "%Y"),
  open_source_content = TRUE, content_license = "CC BY 4.0",
  open_source_data = TRUE, data_license = "CC0",
  open_source_code = TRUE, code_license = "MIT")

Arguments

author

The author of the course. This can be an organization.

year

The year the course was written.

open_source_content

If TRUE a Creative Commons content license will be included pertaining to the content of your course.

content_license

Specify which Creative Commons license you would like to use for the content of your course. This must be equal to one of the following: "CC BY 4.0", "CC BY-SA 4.0", "CC BY-ND 4.0", "CC BY-NC 4.0", "CC BY-NC-SA 4.0", "CC BY-NC-ND 4.0", or "CC0".

open_source_data

If TRUE a Creative Commons content license will be included pertaining to the data distributed with your course.

data_license

Currently this value must be equal to "CC0", but in the future it may be able to be other values.

open_source_code

If TRUE a free software license will be included pertaining to the software included in your course.

code_license

Specify which open source software license you would like to use for the content of your course. This must be equal to one of the following: "MIT", "GPL3", "CC0".

Examples

# NOT RUN {
# Add a license with simple open source options
add_license("Team swirl")

# Add a license so that derivative works are shared alike
add_license("Team swirl", content_license  = "CC BY-SA 4.0", code_license ="GPL3")

# Add a license that reserves all of the author's rights
add_license("Team Bizzaro swirl", open_source_content = FALSE,
                                  open_source_data = FALSE,
                                  open_source_code = FALSE)
# }