From 27aff0ac348651afc199d7070c06d6c021248df7 Mon Sep 17 00:00:00 2001 From: jonas-hurst Date: Sat, 4 Sep 2021 12:05:54 +0200 Subject: [PATCH] major code restructuring: renamed package tissot -> advancedtissot --- tissot/.Rbuildignore => .Rbuildignore | 2 +- .gitignore | 39 ------------------- DESCRIPTION | 30 ++++++++++++++ LICENSE | 21 ---------- tissot/LICENSE.md => LICENSE.md | 0 NAMESPACE | 1 + {tissot/R => R}/tissot.R | 0 README.md | 1 - tissot/tissot.Rproj => advancedtissot.Rproj | 6 +-- man/hello.Rd | 12 ++++++ test-doc.txt | 1 - tissot/.gitignore | 2 - tissot/DESCRIPTION | 24 ------------ tissot/NAMESPACE | 10 ----- tissot/man/get_geometry.tissot.Rd | 19 --------- tissot/man/get_indicatrix.tissot.Rd | 17 -------- tissot/man/plot.tissot.Rd | 17 -------- tissot/man/print.tissot.Rd | 14 ------- tissot/man/summarize.tissot.Rd | 14 ------- tissot/man/tissot.Rd | 26 ------------- {tissot/vignettes => vignettes}/.gitignore | 0 .../tissot.Rmd => vignettes/tisot.Rmd | 0 22 files changed, 46 insertions(+), 210 deletions(-) rename tissot/.Rbuildignore => .Rbuildignore (65%) delete mode 100644 .gitignore create mode 100644 DESCRIPTION delete mode 100644 LICENSE rename tissot/LICENSE.md => LICENSE.md (100%) create mode 100644 NAMESPACE rename {tissot/R => R}/tissot.R (100%) delete mode 100644 README.md rename tissot/tissot.Rproj => advancedtissot.Rproj (74%) create mode 100644 man/hello.Rd delete mode 100644 test-doc.txt delete mode 100644 tissot/.gitignore delete mode 100644 tissot/DESCRIPTION delete mode 100644 tissot/NAMESPACE delete mode 100644 tissot/man/get_geometry.tissot.Rd delete mode 100644 tissot/man/get_indicatrix.tissot.Rd delete mode 100644 tissot/man/plot.tissot.Rd delete mode 100644 tissot/man/print.tissot.Rd delete mode 100644 tissot/man/summarize.tissot.Rd delete mode 100644 tissot/man/tissot.Rd rename {tissot/vignettes => vignettes}/.gitignore (100%) rename tissot/vignettes/tissot.Rmd => vignettes/tisot.Rmd (100%) diff --git a/tissot/.Rbuildignore b/.Rbuildignore similarity index 65% rename from tissot/.Rbuildignore rename to .Rbuildignore index 1e475b8..e13c405 100644 --- a/tissot/.Rbuildignore +++ b/.Rbuildignore @@ -1,3 +1,3 @@ -^tissot\.Rproj$ +^.*\.Rproj$ ^\.Rproj\.user$ ^LICENSE\.md$ diff --git a/.gitignore b/.gitignore deleted file mode 100644 index fae8299..0000000 --- a/.gitignore +++ /dev/null @@ -1,39 +0,0 @@ -# History files -.Rhistory -.Rapp.history - -# Session Data files -.RData - -# User-specific files -.Ruserdata - -# Example code in package build process -*-Ex.R - -# Output files from R CMD build -/*.tar.gz - -# Output files from R CMD check -/*.Rcheck/ - -# RStudio files -.Rproj.user/ - -# produced vignettes -vignettes/*.html -vignettes/*.pdf - -# OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3 -.httr-oauth - -# knitr and R markdown default cache directories -*_cache/ -/cache/ - -# Temporary files created by R markdown -*.utf8.md -*.knit.md - -# R Environment Variables -.Renviron diff --git a/DESCRIPTION b/DESCRIPTION new file mode 100644 index 0000000..34a89e5 --- /dev/null +++ b/DESCRIPTION @@ -0,0 +1,30 @@ +Package: advancedtissot +Title: This package computes Tissot's indicatrix +Version: 0.9 +Type: Package +Authors@R: c( + person(given = "Jonas", + family = "Hurst", + role = c("aut", "cre"), + email = "jhurst@uni-muenster.de"), + person(given = "Brian", + family = "Pondi", + role = c("aut", "ctb"), + email = "brian.pondi@uni-muenster.de") + ) +Maintainer: Jonas Hurst +Description: This package computes Tissot's indicatrix +License: GPL (>= 3) +Encoding: UTF-8 +LazyData: false +Roxygen: list(markdown = TRUE) +RoxygenNote: 7.1.1 +Imports: + sf, + ggplot2 +Suggests: + rmarkdown, + knitr, + rnaturalearth, + rgeos +VignetteBuilder: knitr diff --git a/LICENSE b/LICENSE deleted file mode 100644 index becdb6a..0000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2021 jonas-hurst - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/tissot/LICENSE.md b/LICENSE.md similarity index 100% rename from tissot/LICENSE.md rename to LICENSE.md diff --git a/NAMESPACE b/NAMESPACE new file mode 100644 index 0000000..d75f824 --- /dev/null +++ b/NAMESPACE @@ -0,0 +1 @@ +exportPattern("^[[:alpha:]]+") diff --git a/tissot/R/tissot.R b/R/tissot.R similarity index 100% rename from tissot/R/tissot.R rename to R/tissot.R diff --git a/README.md b/README.md deleted file mode 100644 index bf6ba66..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -# advanced-tissot \ No newline at end of file diff --git a/tissot/tissot.Rproj b/advancedtissot.Rproj similarity index 74% rename from tissot/tissot.Rproj rename to advancedtissot.Rproj index 766b3b2..398aa14 100644 --- a/tissot/tissot.Rproj +++ b/advancedtissot.Rproj @@ -1,7 +1,7 @@ Version: 1.0 -RestoreWorkspace: No -SaveWorkspace: No +RestoreWorkspace: Default +SaveWorkspace: Default AlwaysSaveHistory: Default EnableCodeIndexing: Yes @@ -14,9 +14,7 @@ LaTeX: pdfLaTeX AutoAppendNewline: Yes StripTrailingWhitespace: Yes -LineEndingConversion: Posix BuildType: Package PackageUseDevtools: Yes PackageInstallArgs: --no-multiarch --with-keep.source -PackageRoxygenize: rd,collate,namespace diff --git a/man/hello.Rd b/man/hello.Rd new file mode 100644 index 0000000..0fa7c4b --- /dev/null +++ b/man/hello.Rd @@ -0,0 +1,12 @@ +\name{hello} +\alias{hello} +\title{Hello, World!} +\usage{ +hello() +} +\description{ +Prints 'Hello, world!'. +} +\examples{ +hello() +} diff --git a/test-doc.txt b/test-doc.txt deleted file mode 100644 index 9daeafb..0000000 --- a/test-doc.txt +++ /dev/null @@ -1 +0,0 @@ -test diff --git a/tissot/.gitignore b/tissot/.gitignore deleted file mode 100644 index e67f93b..0000000 --- a/tissot/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -.Rproj.user -inst/doc diff --git a/tissot/DESCRIPTION b/tissot/DESCRIPTION deleted file mode 100644 index 8d80222..0000000 --- a/tissot/DESCRIPTION +++ /dev/null @@ -1,24 +0,0 @@ -Package: tissot -Title: This package computes Tissot's indicatrix -Version: 0.0.0.9000 -Authors@R: - person(given = "Jonas", - family = "Hurst", - role = c("aut", "cre"), - email = "jhurst@uni-muenster.de", - comment = c(ORCID = "YOUR-ORCID-ID")) -Description: What the package does (one paragraph). -License: GPL (>= 3) -Encoding: UTF-8 -LazyData: true -Roxygen: list(markdown = TRUE) -RoxygenNote: 7.1.1 -Imports: - sf, - ggplot2 -Suggests: - rmarkdown, - knitr, - rnaturalearth, - rgeos -VignetteBuilder: knitr diff --git a/tissot/NAMESPACE b/tissot/NAMESPACE deleted file mode 100644 index 9b421d3..0000000 --- a/tissot/NAMESPACE +++ /dev/null @@ -1,10 +0,0 @@ -# Generated by roxygen2: do not edit by hand - -S3method(plot,tissot) -S3method(print,tissot) -export(get_geometry.tissot) -export(get_indicatrix.tissot) -export(summarize.tissot) -export(tissot) -import(ggplot2) -import(sf) diff --git a/tissot/man/get_geometry.tissot.Rd b/tissot/man/get_geometry.tissot.Rd deleted file mode 100644 index 1e1a3c2..0000000 --- a/tissot/man/get_geometry.tissot.Rd +++ /dev/null @@ -1,19 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/tissot.R -\name{get_geometry.tissot} -\alias{get_geometry.tissot} -\title{This function returns the original geometries, from which Tissot indicatrix -was generated} -\usage{ -get_geometry.tissot(obj) -} -\arguments{ -\item{obj}{tissot object} -} -\value{ -Original geometry as objects of class sf -} -\description{ -This function returns the original geometries, from which Tissot indicatrix -was generated -} diff --git a/tissot/man/get_indicatrix.tissot.Rd b/tissot/man/get_indicatrix.tissot.Rd deleted file mode 100644 index c9915d3..0000000 --- a/tissot/man/get_indicatrix.tissot.Rd +++ /dev/null @@ -1,17 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/tissot.R -\name{get_indicatrix.tissot} -\alias{get_indicatrix.tissot} -\title{This function returns the Tissot indicatrix circles that were generated} -\usage{ -get_indicatrix.tissot(obj) -} -\arguments{ -\item{obj}{tissot object} -} -\value{ -Tissot indicatrix as polygon objects of class sf -} -\description{ -This function returns the Tissot indicatrix circles that were generated -} diff --git a/tissot/man/plot.tissot.Rd b/tissot/man/plot.tissot.Rd deleted file mode 100644 index 67b31a1..0000000 --- a/tissot/man/plot.tissot.Rd +++ /dev/null @@ -1,17 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/tissot.R -\name{plot.tissot} -\alias{plot.tissot} -\title{This function plots the sf geometry and Tissot indicatrix circles that were generated} -\usage{ -\method{plot}{tissot}(obj, crs = "auto") -} -\arguments{ -\item{obj}{tissot object} - -\item{crs}{target coordinate reference system: object of class 'crs', or input string for st_crs, -default is automatic} -} -\description{ -This function plots the sf geometry and Tissot indicatrix circles that were generated -} diff --git a/tissot/man/print.tissot.Rd b/tissot/man/print.tissot.Rd deleted file mode 100644 index 42fea8f..0000000 --- a/tissot/man/print.tissot.Rd +++ /dev/null @@ -1,14 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/tissot.R -\name{print.tissot} -\alias{print.tissot} -\title{This function prints Tissot indicatrix circles that were generated} -\usage{ -\method{print}{tissot}(obj) -} -\arguments{ -\item{obj}{tissot object} -} -\description{ -This function prints Tissot indicatrix circles that were generated -} diff --git a/tissot/man/summarize.tissot.Rd b/tissot/man/summarize.tissot.Rd deleted file mode 100644 index 46c878c..0000000 --- a/tissot/man/summarize.tissot.Rd +++ /dev/null @@ -1,14 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/tissot.R -\name{summarize.tissot} -\alias{summarize.tissot} -\title{This function summarizes Tissot indicatrix circles details} -\usage{ -summarize.tissot(obj) -} -\arguments{ -\item{obj}{tissot object} -} -\description{ -This function summarizes Tissot indicatrix circles details -} diff --git a/tissot/man/tissot.Rd b/tissot/man/tissot.Rd deleted file mode 100644 index 33ddf10..0000000 --- a/tissot/man/tissot.Rd +++ /dev/null @@ -1,26 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/tissot.R -\name{tissot} -\alias{tissot} -\title{This function generates Tissot's indicatrix} -\usage{ -tissot(geom, circles_den = "auto", circle_size = "auto") -} -\arguments{ -\item{geom}{input geometry for which tissot should be generated} - -\item{circles_den}{Specifies the number of indicatrix circles that are generated. -Default is automatic. Manually, number of circles in x and y direction can be -specified through an array, e.g. c(20, 10).} - -\item{circle_size}{Specifies the size of each indicatrix circle. Default it is -automatic. Manually, size in Meters should be specified.} -} -\value{ -circles as objects of class sf -} -\description{ -This function returns equally-sized circles (radius = 300km) as sf-polygons -to use as Tissot's indicatrix. The circles are located on a regular grid in -lon/lat every 20 degrees. -} diff --git a/tissot/vignettes/.gitignore b/vignettes/.gitignore similarity index 100% rename from tissot/vignettes/.gitignore rename to vignettes/.gitignore diff --git a/tissot/vignettes/tissot.Rmd b/vignettes/tisot.Rmd similarity index 100% rename from tissot/vignettes/tissot.Rmd rename to vignettes/tisot.Rmd