Merge pull request #79 from UrbanInstitute/update-terms

add terms of use notice
UrbanInstitute · Jan 22, 2021 · b63cf1c · b63cf1c
2 parents 6d55e83 + ad8a017
commit b63cf1c
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 0 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -5,3 +5,5 @@
 ^benchmarks/*
 ^\.travis\.yml$
 ^LICENSE\.md$
+^doc$
+^Meta$
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,5 @@ vignettes/*.R
 .DS_Store
 test.R
 benchmarks/*
+doc
+Meta
diff --git a/README.Rmd b/README.Rmd
@@ -18,6 +18,10 @@ knitr::opts_chunk$set(
 
 Retrieve data from the Urban Institute's [Education Data API](https://ed-data-portal.urban.org/) as a `data.frame` for easy analysis.
 
+**NOTE**: By downloading and using this programming package, you agree to abide
+by the Data Policy and Terms of Use of the Education Data Portal. For more 
+information, see [https://educationdata.urban.org/documentation/#terms](https://educationdata.urban.org/documentation/#terms).
+
 ## Installation
 
 To install `educationdata`:

diff --git a/README.md b/README.md
@@ -10,6 +10,11 @@ Retrieve data from the Urban Institute’s [Education Data
 API](https://ed-data-portal.urban.org/) as a `data.frame` for easy
 analysis.
 
+**NOTE**: By downloading and using this programming package, you agree
+to abide by the Data Policy and Terms of Use of the Education Data
+Portal. For more information, see
+<https://educationdata.urban.org/documentation/#terms>.
+
 ## Installation
 
 To install `educationdata`:

diff --git a/vignettes/introducing-educationdata.Rmd b/vignettes/introducing-educationdata.Rmd
@@ -22,6 +22,10 @@ Institute's [Education Data API](https://ed-data-portal.urban.org/) as a
 `get_education_data`, which will get data from a specified API endpoint and 
 return a `data.frame` to the user.
 
+**NOTE**: By downloading and using this programming package, you agree to abide
+by the Data Policy and Terms of Use of the Education Data Portal. For more 
+information, see [https://educationdata.urban.org/documentation/#terms](https://educationdata.urban.org/documentation/#terms)
+
 ## Usage
 
 The `get_education_data` function will return a `data.frame` from a call to
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,3 +8,5 @@ vignettes/*.R @@
     .DS_Store
     test.R
     benchmarks/*
+    doc
+    Meta