From 979d756c0c0f2fc5ed858f0a543e23377a9ba1fb Mon Sep 17 00:00:00 2001 From: baz9527 <simon.bartke@uni-hamburg.de> Date: Wed, 4 May 2022 13:46:06 +0200 Subject: [PATCH] Added skeletons for dataset doku Final check passed Installed locally --- .Rbuildignore | 1 + DESCRIPTION | 3 +-- LICENSE | 2 ++ LICENSE.md | 21 +++++++++++++++++++++ R/cobb_douglas.R | 12 ++++++++++++ R/eduinc.R | 15 +++++++++++++++ R/food.R | 12 ++++++++++++ R/phillips.R | 12 ++++++++++++ R/qtm.R | 12 ++++++++++++ R/sozoeko1.R | 26 ++++++++++++++++++++++++++ man/cobb_douglas.Rd | 24 ++++++++++++++++++++++++ man/eduinc.Rd | 27 +++++++++++++++++++++++++++ man/food.Rd | 24 ++++++++++++++++++++++++ man/phillips.Rd | 24 ++++++++++++++++++++++++ man/qtm.Rd | 24 ++++++++++++++++++++++++ man/sozoeko1.Rd | 40 ++++++++++++++++++++++++++++++++++++++++ 16 files changed, 277 insertions(+), 2 deletions(-) create mode 100644 LICENSE create mode 100644 LICENSE.md create mode 100644 R/cobb_douglas.R create mode 100644 R/eduinc.R create mode 100644 R/food.R create mode 100644 R/phillips.R create mode 100644 R/qtm.R create mode 100644 R/sozoeko1.R create mode 100644 man/cobb_douglas.Rd create mode 100644 man/eduinc.Rd create mode 100644 man/food.Rd create mode 100644 man/phillips.Rd create mode 100644 man/qtm.Rd create mode 100644 man/sozoeko1.Rd diff --git a/.Rbuildignore b/.Rbuildignore index 8526030..b6c75b8 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,3 +1,4 @@ ^sozoeko1\.Rproj$ ^\.Rproj\.user$ ^data-raw$ +^LICENSE\.md$ diff --git a/DESCRIPTION b/DESCRIPTION index b254f30..ef4a3e7 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -4,8 +4,7 @@ Version: 0.0.0.9000 Authors@R: person("Simon", "Bartke", , "simon.bartke@uni-hamburg.de", role = c("aut", "cre")) Description: Dieses Paket stellt sechs Datensätze (cobb-douglas, eduinc, food, gfc, phillips und qtm) zur Verfügung, welche im Rahmen der Lehre des Kurses Oekonometrie 1 verwendet werden. -License: `use_mit_license()`, `use_gpl3_license()` or friends to pick a - license +License: MIT + file LICENSE Encoding: UTF-8 Roxygen: list(markdown = TRUE) RoxygenNote: 7.1.2 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..750ec70 --- /dev/null +++ b/LICENSE @@ -0,0 +1,2 @@ +YEAR: 2022 +COPYRIGHT HOLDER: sozoeko1 authors diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..c96d717 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +# MIT License + +Copyright (c) 2022 sozoeko1 authors + +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/R/cobb_douglas.R b/R/cobb_douglas.R new file mode 100644 index 0000000..11b9216 --- /dev/null +++ b/R/cobb_douglas.R @@ -0,0 +1,12 @@ +#' Kurze Beschreibung des Datensatzes (hier eigene Beschreibung ergaenzen) +#' +#' Etwas laengere Beschreibung des Datensatzes (hier eigene Besachreibung ergaenzen) +#' +#' @format A tibble with 33 rows and 3 variables: +#' \describe{ +#' \item{k}{dbl ?} +#' \item{l}{dbl ?} +#' \item{q}{dbl ?} +#' } +#' @source \url{Quellangabe (hier beispielsweise als Link)} +"cobb_douglas" # Name Ihres Datensatzes diff --git a/R/eduinc.R b/R/eduinc.R new file mode 100644 index 0000000..63d11a2 --- /dev/null +++ b/R/eduinc.R @@ -0,0 +1,15 @@ +#' Kurze Beschreibung des Datensatzes (hier eigene Beschreibung ergaenzen) +#' +#' Etwas laengere Beschreibung des Datensatzes (hier eigene Besachreibung ergaenzen) +#' +#' @format A tibble with 428 rows and 6 variables: +#' \describe{ +#' \item{faminc}{dbl ?} +#' \item{he}{dbl ?} +#' \item{we}{dbl ?} +#' \item{kl6}{dbl ?} +#' \item{xtra_x5}{dbl ?} +#' \item{xtra_x6}{dbl ?} +#' } +#' @source \url{Quellangabe (hier beispielsweise als Link)} +"eduinc" # Name Ihres Datensatzes diff --git a/R/food.R b/R/food.R new file mode 100644 index 0000000..478a69e --- /dev/null +++ b/R/food.R @@ -0,0 +1,12 @@ +#' Kurze Beschreibung des Datensatzes (hier eigene Beschreibung ergaenzen) +#' +#' Etwas laengere Beschreibung des Datensatzes (hier eigene Besachreibung ergaenzen) +#' +#' @format A tibble with 40 rows and 3 variables: +#' \describe{ +#' \item{X}{dbl ?} +#' \item{food_exp}{dbl ?} +#' \item{income}{dbl ?} +#' } +#' @source \url{Quellangabe (hier beispielsweise als Link)} +"food" # Name Ihres Datensatzes diff --git a/R/phillips.R b/R/phillips.R new file mode 100644 index 0000000..e9a5244 --- /dev/null +++ b/R/phillips.R @@ -0,0 +1,12 @@ +#' Kurze Beschreibung des Datensatzes (hier eigene Beschreibung ergaenzen) +#' +#' Etwas laengere Beschreibung des Datensatzes (hier eigene Besachreibung ergaenzen) +#' +#' @format A tibble with 91 rows and 3 variables: +#' \describe{ +#' \item{obs}{chr ?} +#' \item{inf}{dbl ?} +#' \item{u}{dbl ?} +#' } +#' @source \url{Quellangabe (hier beispielsweise als Link)} +"phillips" # Name Ihres Datensatzes diff --git a/R/qtm.R b/R/qtm.R new file mode 100644 index 0000000..9a6c5ba --- /dev/null +++ b/R/qtm.R @@ -0,0 +1,12 @@ +#' Kurze Beschreibung des Datensatzes (hier eigene Beschreibung ergaenzen) +#' +#' Etwas laengere Beschreibung des Datensatzes (hier eigene Besachreibung ergaenzen) +#' +#' @format A tibble with 180 rows and 3 variables: +#' \describe{ +#' \item{obs}{chr ?} +#' \item{m}{dbl ?} +#' \item{p}{dbl ?} +#' } +#' @source \url{Quellangabe (hier beispielsweise als Link)} +"qtm" # Name Ihres Datensatzes diff --git a/R/sozoeko1.R b/R/sozoeko1.R new file mode 100644 index 0000000..9493fd4 --- /dev/null +++ b/R/sozoeko1.R @@ -0,0 +1,26 @@ +#' sozoeko1: Ein Paket, welches die Lehre der Veranstaltung Oekonometrie 1 im Bachelor Sozialoekonomie an der WiSo-Fakultaet der Uni Hamburg unterstuetzt. +#' +#' Das sozoeko1 Paket besteht aus sechs Datensätzen, welche im Rahmen der Lehre verwendet werden: +#' cobb-douglas, eduinc, food, gfc, phillips und qtm. +#' +#' @section cobb-douglas Datensatz: +#' XY... +#' +#' @section eduinc Datensatz: +#' XY... +#' +#' @section food Datensatz: +#' XY... +#' +#' @section gfc Datensatz: +#' XY... +#' +#' @section phillips Datensatz: +#' XY... +#' +#' @section qtm Datensatz: +#' XY... +#' +#' @docType package +#' @name sozoeko1 +NULL diff --git a/man/cobb_douglas.Rd b/man/cobb_douglas.Rd new file mode 100644 index 0000000..cbc6893 --- /dev/null +++ b/man/cobb_douglas.Rd @@ -0,0 +1,24 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/cobb_douglas.R +\docType{data} +\name{cobb_douglas} +\alias{cobb_douglas} +\title{Kurze Beschreibung des Datensatzes (hier eigene Beschreibung ergaenzen)} +\format{ +A tibble with 33 rows and 3 variables: +\describe{ +\item{k}{dbl ?} +\item{l}{dbl ?} +\item{q}{dbl ?} +} +} +\source{ +\url{Quellangabe (hier beispielsweise als Link)} +} +\usage{ +cobb_douglas +} +\description{ +Etwas laengere Beschreibung des Datensatzes (hier eigene Besachreibung ergaenzen) +} +\keyword{datasets} diff --git a/man/eduinc.Rd b/man/eduinc.Rd new file mode 100644 index 0000000..a4f82f2 --- /dev/null +++ b/man/eduinc.Rd @@ -0,0 +1,27 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/eduinc.R +\docType{data} +\name{eduinc} +\alias{eduinc} +\title{Kurze Beschreibung des Datensatzes (hier eigene Beschreibung ergaenzen)} +\format{ +A tibble with 428 rows and 6 variables: +\describe{ +\item{faminc}{dbl ?} +\item{he}{dbl ?} +\item{we}{dbl ?} +\item{kl6}{dbl ?} +\item{xtra_x5}{dbl ?} +\item{xtra_x6}{dbl ?} +} +} +\source{ +\url{Quellangabe (hier beispielsweise als Link)} +} +\usage{ +eduinc +} +\description{ +Etwas laengere Beschreibung des Datensatzes (hier eigene Besachreibung ergaenzen) +} +\keyword{datasets} diff --git a/man/food.Rd b/man/food.Rd new file mode 100644 index 0000000..84a96ef --- /dev/null +++ b/man/food.Rd @@ -0,0 +1,24 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/food.R +\docType{data} +\name{food} +\alias{food} +\title{Kurze Beschreibung des Datensatzes (hier eigene Beschreibung ergaenzen)} +\format{ +A tibble with 40 rows and 3 variables: +\describe{ +\item{X}{dbl ?} +\item{food_exp}{dbl ?} +\item{income}{dbl ?} +} +} +\source{ +\url{Quellangabe (hier beispielsweise als Link)} +} +\usage{ +food +} +\description{ +Etwas laengere Beschreibung des Datensatzes (hier eigene Besachreibung ergaenzen) +} +\keyword{datasets} diff --git a/man/phillips.Rd b/man/phillips.Rd new file mode 100644 index 0000000..1fa0185 --- /dev/null +++ b/man/phillips.Rd @@ -0,0 +1,24 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/phillips.R +\docType{data} +\name{phillips} +\alias{phillips} +\title{Kurze Beschreibung des Datensatzes (hier eigene Beschreibung ergaenzen)} +\format{ +A tibble with 91 rows and 3 variables: +\describe{ +\item{obs}{chr ?} +\item{inf}{dbl ?} +\item{u}{dbl ?} +} +} +\source{ +\url{Quellangabe (hier beispielsweise als Link)} +} +\usage{ +phillips +} +\description{ +Etwas laengere Beschreibung des Datensatzes (hier eigene Besachreibung ergaenzen) +} +\keyword{datasets} diff --git a/man/qtm.Rd b/man/qtm.Rd new file mode 100644 index 0000000..a09221e --- /dev/null +++ b/man/qtm.Rd @@ -0,0 +1,24 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/qtm.R +\docType{data} +\name{qtm} +\alias{qtm} +\title{Kurze Beschreibung des Datensatzes (hier eigene Beschreibung ergaenzen)} +\format{ +A tibble with 180 rows and 3 variables: +\describe{ +\item{obs}{chr ?} +\item{m}{dbl ?} +\item{p}{dbl ?} +} +} +\source{ +\url{Quellangabe (hier beispielsweise als Link)} +} +\usage{ +qtm +} +\description{ +Etwas laengere Beschreibung des Datensatzes (hier eigene Besachreibung ergaenzen) +} +\keyword{datasets} diff --git a/man/sozoeko1.Rd b/man/sozoeko1.Rd new file mode 100644 index 0000000..cf5b5c9 --- /dev/null +++ b/man/sozoeko1.Rd @@ -0,0 +1,40 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/sozoeko1.R +\docType{package} +\name{sozoeko1} +\alias{sozoeko1} +\title{sozoeko1: Ein Paket, welches die Lehre der Veranstaltung Oekonometrie 1 im Bachelor Sozialoekonomie an der WiSo-Fakultaet der Uni Hamburg unterstuetzt.} +\description{ +Das sozoeko1 Paket besteht aus sechs Datensätzen, welche im Rahmen der Lehre verwendet werden: +cobb-douglas, eduinc, food, gfc, phillips und qtm. +} +\section{cobb-douglas Datensatz}{ + +XY... +} + +\section{eduinc Datensatz}{ + +XY... +} + +\section{food Datensatz}{ + +XY... +} + +\section{gfc Datensatz}{ + +XY... +} + +\section{phillips Datensatz}{ + +XY... +} + +\section{qtm Datensatz}{ + +XY... +} + -- GitLab