initial commit

zambujo · Jun 8, 2020 · d606a86 · d606a86
commit d606a86
Show file tree

Hide file tree

Showing 12 changed files with 196 additions and 0 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -0,0 +1,8 @@
+^headliner\.Rproj$
+^\.Rproj\.user$
+^LICENSE\.md$
+^data-raw$
+^inst/extdata$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,45 @@
+# tmp
+data-raw
+
+# History files
+.Rhistory
+.Rapp.history
+
+# Session Data files
+.RData
+.RDataTmp
+
+# 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.Bookdown Stack ###
+# R package: bookdown caching files
+/*_files/
+docs
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -0,0 +1,20 @@
+Type: package
+Package: headliner
+Title: Template for headlines
+Version: 0.0.0.9000
+Authors@R: 
+    person(given = "Joao",
+           family = "Martins",
+           role = c("aut", "cre"),
+           email = "joao.martins@gmx.net",
+           comment = c(ORCID = "0000-0001-7961-4280"))
+Description: A tool for publishing headlines.
+License: MIT + file LICENSE
+URL: https://github.com/zambujo/headliner
+BugReports: https://github.com/zambujo/headliner/issues
+Encoding: UTF-8
+LazyData: true
+Roxygen: list(markdown = TRUE)
+RoxygenNote: 7.1.0
+Depends: 
+    R (>= 2.10)
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,2 @@
+YEAR: 2020
+COPYRIGHT HOLDER: Joao Martins
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2020 Joao Martins
+
+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/NAMESPACE b/NAMESPACE
@@ -0,0 +1,2 @@
+# Generated by roxygen2: do not edit by hand
+
diff --git a/R/data.R b/R/data.R
@@ -0,0 +1,13 @@
+#' Headlines sourced from sciencegeist.com's RSS feed
+#'
+#' A dataset containing 118 headlines in science policy.
+#'
+#' @format A data frame with 118 rows and 4 columns:
+#' \describe{
+#' \item{title}{Title of the headline.}
+#' \item{description}{Description of the headline in html, including a link to an image.}
+#' \item{pubDate}{Headline timestamp.}
+#' \item{link}{Link to the original source.}
+#' }
+#' @source \url{https://www.sciencegeist.ch/news/rss}
+"sciencegeist"
diff --git a/README.md b/README.md
@@ -0,0 +1,24 @@
+
+# headliner
+
+<!-- badges: start -->
+<!-- badges: end -->
+
+headliner is a tool to publish headlines.  It provides a static generator for headlines.  For example, it is ideal to quickly publish and distribute RSS feeds.
+
+## Installation
+
+You can install the released version of headliner from [CRAN](https://CRAN.R-project.org) with:
+
+``` r
+install.packages("headliner")
+```
+
+## Example
+
+This is a basic example which shows you how to solve a common problem:
+
+``` r
+library(headliner)
+```
+
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -0,0 +1,15 @@
+url: https://zambujo.github.io/headliner/
+authors:
+  Joao Martins:
+    href: https://github.com/zambujo
+
+home:
+  title: Publishing headlines with R Markdown
+  description: Make your RSS feeds look good.
+
+template:
+  params:
+    bootswatch: simplex
+  opengraph:
+    twitter:
+      creator: "@joaoTweeted"
diff --git a/data/sciencegeist.rda b/data/sciencegeist.rda
diff --git a/headliner.Rproj b/headliner.Rproj
@@ -0,0 +1,21 @@
+Version: 1.0
+
+RestoreWorkspace: No
+SaveWorkspace: No
+AlwaysSaveHistory: Default
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: Sweave
+LaTeX: pdfLaTeX
+
+AutoAppendNewline: Yes
+StripTrailingWhitespace: Yes
+
+BuildType: Package
+PackageUseDevtools: Yes
+PackageInstallArgs: --no-multiarch --with-keep.source
+PackageRoxygenize: rd,collate,namespace
diff --git a/man/sciencegeist.Rd b/man/sciencegeist.Rd