From 5e6e0cc58c8c8f5c239f3e1b304be82648086b65 Mon Sep 17 00:00:00 2001 From: Matthew Grainger Date: Mon, 15 May 2023 15:09:03 +0200 Subject: [PATCH] Get ready for first release --- DESCRIPTION | 4 +- NAMESPACE | 5 +- R/functions.R | 8 +- README.Rmd | 8 +- README.md | 12 +- docs/404.html | 119 +++------ docs/LICENSE.html | 279 +++++++-------------- docs/articles/Introduction_to_vikingR.html | 74 +++--- docs/articles/index.html | 114 ++------- docs/authors.html | 151 ++++------- docs/index.html | 81 +++--- docs/pkgdown.css | 83 +++--- docs/pkgdown.js | 4 +- docs/pkgdown.yml | 6 +- docs/reference/index.html | 157 ++---------- docs/reference/scale_colour_viking.html | 158 +++--------- docs/reference/scale_fill_viking.html | 158 +++--------- docs/reference/topNorName1880to2020.html | 135 +++------- docs/reference/viking_cols.html | 130 ++-------- docs/reference/viking_pal.html | 148 +++-------- docs/sitemap.xml | 39 +++ 21 files changed, 596 insertions(+), 1277 deletions(-) create mode 100644 docs/sitemap.xml diff --git a/DESCRIPTION b/DESCRIPTION index 15d0312..451c0e3 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: vikingR Type: Package Title: Creates a Viking Era ggplot2 palette -Version: 0.1.0 +Version: 0.0.0.9000 Authors@R: c( person("Matt", "Grainger", , "matthew.grainger@nina.no", role = c("aut", "cre")), person("Gavin","Stewart", role = c("aut")) @@ -11,7 +11,7 @@ License: GPL (>= 3) Encoding: UTF-8 LazyData: true Imports: ggplot2 -RoxygenNote: 7.1.2 +RoxygenNote: 7.2.3 Suggests: rmarkdown, knitr diff --git a/NAMESPACE b/NAMESPACE index d75f824..d8d9855 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1 +1,4 @@ -exportPattern("^[[:alpha:]]+") +# Generated by roxygen2: do not edit by hand + +export(scale_colour_viking) +export(scale_fill_viking) diff --git a/R/functions.R b/R/functions.R index 3bc46cd..ae91537 100644 --- a/R/functions.R +++ b/R/functions.R @@ -66,9 +66,9 @@ scale_colour_viking <- function(palette = "Alle", discrete = TRUE, reverse = FAL pal <- viking_pal(palette = palette, reverse = reverse) if (discrete) { - discrete_scale("colour", paste0("viking_", palette), palette = pal, ...) + ggplot2::discrete_scale("colour", paste0("viking_", palette), palette = pal, ...) } else { - scale_colour_gradientn(colours = pal(256), ...) + ggplot2::scale_colour_gradientn(colours = pal(256), ...) } } @@ -84,8 +84,8 @@ scale_fill_viking <- function(palette = "Alle", discrete = TRUE, reverse = FALSE pal <- viking_pal(palette = palette, reverse = reverse) if (discrete) { - discrete_scale("fill", paste0("viking_", palette), palette = pal, ...) + ggplot2::discrete_scale("fill", paste0("viking_", palette), palette = pal, ...) } else { - scale_fill_gradientn(colours = pal(256), ...) + ggplot2::scale_fill_gradientn(colours = pal(256), ...) } } diff --git a/README.Rmd b/README.Rmd index 43498c7..5ae4172 100644 --- a/README.Rmd +++ b/README.Rmd @@ -18,15 +18,15 @@ knitr::opts_chunk$set( -vikingR creates a Viking era ggplot palette. Inspired by this [publication](https://tinyurl.com/bdfjhv25). +vikingR creates a Viking era ggplot palette. Inspired by this [publication](https://tinyurl.com/bdfjhv25). The National Museum of Denmark working with Chemists were able to recreate some of the colours that were common in the Viking era. Of course we can not know for sure if this were the only colours available at the time. ## Installation You can install the development version of vikingR from [GitHub](https://github.com/) with: ``` r -# install.packages("devtools") -devtools::install_github("DrMattG/vikingR") +# install.packages("remotes") +remotes::install_github("DrMattG/vikingR") ``` ## Example @@ -37,7 +37,7 @@ This is the basic usage: library(vikingR) library(tidyverse, quietly = TRUE) data("topNorName1880to2020") -topNorName1880to2020%>% +topNorName1880to2020 |> ggplot(aes(reorder(name,n),n, fill=name)) + geom_histogram(stat="identity") + scale_fill_viking(palette = "Alle", guide = "none")+ diff --git a/README.md b/README.md index 09a9271..88e040e 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,13 @@ # vikingR - vikingR creates a Viking era ggplot palette. Inspired by this -[publication](https://tinyurl.com/bdfjhv25). +[publication](https://tinyurl.com/bdfjhv25). The National Museum of +Denmark working with Chemists were able to recreate some of the colours +that were common in the Viking era. Of course we can not know for sure +if this were the only colours available at the time. ## Installation @@ -16,8 +18,8 @@ You can install the development version of vikingR from [GitHub](https://github.com/) with: ``` r -# install.packages("devtools") -devtools::install_github("DrMattG/vikingR") +# install.packages("remotes") +remotes::install_github("DrMattG/vikingR") ``` ## Example @@ -28,7 +30,7 @@ This is the basic usage: library(vikingR) library(tidyverse, quietly = TRUE) data("topNorName1880to2020") -topNorName1880to2020%>% +topNorName1880to2020 |> ggplot(aes(reorder(name,n),n, fill=name)) + geom_histogram(stat="identity") + scale_fill_viking(palette = "Alle", guide = "none")+ diff --git a/docs/404.html b/docs/404.html index 1442b46..cc905fb 100644 --- a/docs/404.html +++ b/docs/404.html @@ -1,66 +1,27 @@ - - - - + + + + - Page not found (404) • vikingR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + - - - - -
-
- + +
+ + + - - -
+

Page not found (404)

@@ -122,31 +75,31 @@

Page not found (404)

+
-
-
-

Developed by Matt Grainger, Gavin Stewart.

+
+

+

Developed by Matt Grainger, Gavin Stewart.

-

Site built with pkgdown 1.6.1.

+

+

Site built with pkgdown 2.0.7.

-
+
+ + - - diff --git a/docs/LICENSE.html b/docs/LICENSE.html index a18b636..8da21e0 100644 --- a/docs/LICENSE.html +++ b/docs/LICENSE.html @@ -1,66 +1,12 @@ - - - - - - - -GNU General Public License • vikingR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GNU General Public License • vikingR - - - - + + -
-
- -
- -
+

GNU General Public License

@@ -119,11 +49,10 @@

GNU General Public License

-

Version 3, 29 June 2007
Copyright © 2007 Free Software Foundation, Inc. <http://fsf.org/>

+

Version 3, 29 June 2007
Copyright © 2007 Free Software Foundation, Inc. <http://fsf.org/>

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

-
-

-Preamble

+
+

Preamble

The GNU General Public License is a free, copyleft license for software and other kinds of works.

The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program–to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.

When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.

@@ -135,12 +64,10 @@

Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.

The precise terms and conditions for copying, distribution and modification follow.

-
-

-TERMS AND CONDITIONS

-
-

-0. Definitions

+
+

TERMS AND CONDITIONS

+
+

0. Definitions

“This License” refers to version 3 of the GNU General Public License.

“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.

“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.

@@ -150,9 +77,8 @@

To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.

An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.

-
-

-1. Source Code

+
+

1. Source Code

The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.

A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.

The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.

@@ -160,31 +86,26 @@

The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.

The Corresponding Source for a work in source code form is that same work.

-
-

-2. Basic Permissions

+
+

2. Basic Permissions

All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.

You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.

Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.

-