From d55f44d9e00fb2bdfdad5668f3f3eaf131b152ef Mon Sep 17 00:00:00 2001 From: Alison Appling Date: Thu, 9 Jun 2016 07:56:21 -0500 Subject: [PATCH] R package skeleton --- .Rbuildignore | 2 + .gitignore | 7 +-- DESCRIPTION | 19 ++++++++ LICENSE | 117 ++++++++++++++++++++++++++++++++++++++++++++++++++ NAMESPACE | 2 + NEWS.md | 3 ++ R/vizlab.R | 4 ++ README.md | 32 ++++++++++++++ man/vizlab.Rd | 9 ++++ 9 files changed, 190 insertions(+), 5 deletions(-) create mode 100644 .Rbuildignore create mode 100644 DESCRIPTION create mode 100644 LICENSE create mode 100644 NAMESPACE create mode 100644 NEWS.md create mode 100644 R/vizlab.R create mode 100644 man/vizlab.Rd diff --git a/.Rbuildignore b/.Rbuildignore new file mode 100644 index 0000000..91114bf --- /dev/null +++ b/.Rbuildignore @@ -0,0 +1,2 @@ +^.*\.Rproj$ +^\.Rproj\.user$ diff --git a/.gitignore b/.gitignore index 8eff68f..4447c42 100644 --- a/.gitignore +++ b/.gitignore @@ -1,19 +1,16 @@ # History files .Rhistory .Rapp.history - # Session Data files .RData - # Example code in package build process *-Ex.R - # RStudio files .Rproj.user/ - # produced vignettes vignettes/*.html vignettes/*.pdf - # OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3 .httr-oauth +.Rproj.user +*.Rproj diff --git a/DESCRIPTION b/DESCRIPTION new file mode 100644 index 0000000..71bfe5a --- /dev/null +++ b/DESCRIPTION @@ -0,0 +1,19 @@ +Package: vizlab +Type: Package +Title: Utilities for building online data visualizations +Version: 0.1.0 +Date: 2016-06-09 +Author: Jordan Walker, Jordan Read, Alison Appling +Maintainer: Jordan Walker +Description: Provides utility functions to organize, develop, and publish + web-based data visualizations +License: file LICENSE +Copyright: This software is in the public domain because it contains materials + that originally came from the United States Geological Survey, an agency of + the United States Department of Interior. For more information, see the + official USGS copyright policy at + http://www.usgs.gov/visual-id/credit_usgs.html#copyright +VignetteBuilder: knitr +Depends: + R (>= 3.0) +RoxygenNote: 5.0.1 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..059f176 --- /dev/null +++ b/LICENSE @@ -0,0 +1,117 @@ +CC0 1.0 Universal + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator and +subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for the +purpose of contributing to a commons of creative, cultural and scientific +works ("Commons") that the public can reliably and without fear of later +claims of infringement build upon, modify, incorporate in other works, reuse +and redistribute as freely as possible in any form whatsoever and for any +purposes, including without limitation commercial purposes. These owners may +contribute to the Commons to promote the ideal of a free culture and the +further production of creative, cultural and scientific works, or to gain +reputation or greater distribution for their Work in part through the use and +efforts of others. + +For these and/or other purposes and motivations, and without any expectation +of additional consideration or compensation, the person associating CC0 with a +Work (the "Affirmer"), to the extent that he or she is an owner of Copyright +and Related Rights in the Work, voluntarily elects to apply CC0 to the Work +and publicly distribute the Work under its terms, with knowledge of his or her +Copyright and Related Rights in the Work and the meaning and intended legal +effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and + Related Rights"). Copyright and Related Rights include, but are not limited +to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, communicate, +and translate a Work; + +ii. moral rights retained by the original author(s) and/or performer(s); + +iii. publicity and privacy rights pertaining to a person's image or likeness +depicted in a Work; + +iv. rights protecting against unfair competition in regards to a Work, +subject to the limitations in paragraph 4(a), below; + +v. rights protecting the extraction, dissemination, use and reuse of data in +a Work; + +vi. database rights (such as those arising under Directive 96/9/EC of the +European Parliament and of the Council of 11 March 1996 on the legal +protection of databases, and under any national implementation thereof, +including any amended or successor version of such directive); and + +vii. other similar, equivalent or corresponding rights throughout the world +based on applicable law or treaty, and any national implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention of, +applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and +unconditionally waives, abandons, and surrenders all of Affirmer's Copyright +and Related Rights and associated claims and causes of action, whether now +known or unknown (including existing as well as future claims and causes of + action), in the Work (i) in all territories worldwide, (ii) for the maximum +duration provided by applicable law or treaty (including future time + extensions), (iii) in any current or future medium and for any number of +copies, and (iv) for any purpose whatsoever, including without limitation +commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes +the Waiver for the benefit of each member of the public at large and to the +detriment of Affirmer's heirs and successors, fully intending that such Waiver +shall not be subject to revocation, rescission, cancellation, termination, or +any other legal or equitable action to disrupt the quiet enjoyment of the Work +by the public as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason be +judged legally invalid or ineffective under applicable law, then the Waiver +shall be preserved to the maximum extent permitted taking into account +Affirmer's express Statement of Purpose. In addition, to the extent the Waiver +is so judged Affirmer hereby grants to each affected person a royalty-free, +non transferable, non sublicensable, non exclusive, irrevocable and +unconditional license to exercise Affirmer's Copyright and Related Rights in +the Work (i) in all territories worldwide, (ii) for the maximum duration +provided by applicable law or treaty (including future time extensions), (iii) +in any current or future medium and for any number of copies, and (iv) for any +purpose whatsoever, including without limitation commercial, advertising or +promotional purposes (the "License"). The License shall be deemed effective as +of the date CC0 was applied by Affirmer to the Work. Should any part of the +License for any reason be judged legally invalid or ineffective under +applicable law, such partial invalidity or ineffectiveness shall not +invalidate the remainder of the License, and in such case Affirmer hereby +affirms that he or she will not (i) exercise any of his or her remaining +Copyright and Related Rights in the Work or (ii) assert any associated claims +and causes of action with respect to the Work, in either case contrary to +Affirmer's express Statement of Purpose. + +4. Limitations and Disclaimers. + +a. No trademark or patent rights held by Affirmer are waived, abandoned, +surrendered, licensed or otherwise affected by this document. + +b. Affirmer offers the Work as-is and makes no representations or warranties +of any kind concerning the Work, express, implied, statutory or otherwise, +including without limitation warranties of title, merchantability, fitness +for a particular purpose, non infringement, or the absence of latent or +other defects, accuracy, or the present or absence of errors, whether or not +discoverable, all to the greatest extent permissible under applicable law. + +c. Affirmer disclaims responsibility for clearing rights of other persons +that may apply to the Work or any use thereof, including without limitation +any person's Copyright and Related Rights in the Work. Further, Affirmer +disclaims responsibility for obtaining any necessary consents, permissions +or other rights required for any use of the Work. + +d. Affirmer understands and acknowledges that Creative Commons is not a +party to this document and has no duty or obligation with respect to this +CC0 or use of the Work. + +For more information, please see + + \ No newline at end of file diff --git a/NAMESPACE b/NAMESPACE new file mode 100644 index 0000000..6ae9268 --- /dev/null +++ b/NAMESPACE @@ -0,0 +1,2 @@ +# Generated by roxygen2: do not edit by hand + diff --git a/NEWS.md b/NEWS.md new file mode 100644 index 0000000..e612931 --- /dev/null +++ b/NEWS.md @@ -0,0 +1,3 @@ +# v0.1.0 (2016-06-06) + +* vizlab package created diff --git a/R/vizlab.R b/R/vizlab.R new file mode 100644 index 0000000..5b9d72d --- /dev/null +++ b/R/vizlab.R @@ -0,0 +1,4 @@ +#' Utilities for building online data visualizations +#' +#' @name vizlab +NULL \ No newline at end of file diff --git a/README.md b/README.md index 89f7b19..e9f9a3e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ # vizlab Package with utilities for building vizlab pages + + +## Installation + +The most stable+current version of this package can be installed with this R command: +```r +install.packages("vizlab", dependencies=TRUE, + repos=c("http://owi.usgs.gov/R","https://cran.rstudio.com")) +``` +and updated with this command: +```r +update.packages(oldPkgs=c("vizlab"), + dependencies=TRUE, repos=c("http://owi.usgs.gov/R", "https://cran.rstudio.com")) +``` + +The most cutting edge version of the package can be installed if you have the `devtools` package: +```r +devtools::install_github("USGS-VIZLAB/vizlab") +``` + +## Disclaimer + +This software is in the public domain because it contains materials that originally came from the U.S. Geological Survey, an agency of the United States Department of Interior. For more information, see the official USGS copyright policy at [http://www.usgs.gov/visual-id/credit_usgs.html#copyright](http://www.usgs.gov/visual-id/credit_usgs.html#copyright) + +This information is preliminary or provisional and is subject to revision. It is being provided to meet the need for timely best science. The information has not received final approval by the U.S. Geological Survey (USGS) and is provided on the condition that neither the USGS nor the U.S. Government shall be held liable for any damages resulting from the authorized or unauthorized use of the information. Although this software program has been used by the USGS, no warranty, expressed or implied, is made by the USGS or the U.S. Government as to the accuracy and functioning of the program and related program material nor shall the fact of distribution constitute any such warranty, and no responsibility is assumed by the USGS in connection therewith. + +This software is provided "AS IS." + + + [ + ![CC0](http://i.creativecommons.org/p/zero/1.0/88x31.png) + ](http://creativecommons.org/publicdomain/zero/1.0/) \ No newline at end of file diff --git a/man/vizlab.Rd b/man/vizlab.Rd new file mode 100644 index 0000000..86cebfd --- /dev/null +++ b/man/vizlab.Rd @@ -0,0 +1,9 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/vizlab.R +\name{vizlab} +\alias{vizlab} +\title{Utilities for building online data visualizations} +\description{ +Utilities for building online data visualizations +} +