update repo

.Rbuildignore

@@ -1,2 +1,6 @@
 *.tws
 *.md
+^.*\.Rproj$
+^\.Rproj\.user$
+^LICENSE\.md$
+^_notes$

.gitignore

@@ -1 +1,3 @@
 *.tws
+.Rproj.user
+_notes

DESCRIPTION

@@ -1,15 +1,15 @@
 Package: curatedPCaData
-Title: curated Prostate Cancer Data
+Title: Curated Prostate Cancer Data
 Version: 0.0-2
 Date: 2020-04-03
-Authors@R: person("First", "Last", email = "first.last@example.com",
+Authors@R: person("Daniel", "Laajala", email = "[email protected].com",
                   role = c("aut", "cre"))
 Maintainer: 
-Description: Foo Bar
+Description: A selection of annotated prostate cancer datasets. 
 Depends: R (>= 3.1.0), S4Vectors (>= 0.23.18)
 Imports: cgdsr, annotate, org.Hs.eg.db, biomaRt, GenomicFeatures, GEOquery
 Suggests:
-License: GPL (>= 3)
+License: GPL-3
 Encoding: UTF-8
 RoxygenNote: 6.1.1
 VignetteBuilder: R.rsp

README.Rmd

@@ -0,0 +1,42 @@
+---
+output: github_document
+---
+
+```{r setup, include = FALSE}
+
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  fig.path = "man/figures/README-",
+  out.width = "100%"
+)
+
+```
+
+# curatedPCaData <img src="man/figures/hex.png" align="right" height="139" />
+
+<!-- badges: start -->
+<!-- badges: end -->
+
+## Overview 
+
+`curatedPCaData` is a collection of publically available and annotated data resources
+concerning prostate cancer. 
+
+## Installation
+
+You can install `curatedPCaData` from github with: 
+
+```r
+# install.packages("devtools")
+devtools::install_github("Syksy/curatedPCaData")
+```
+
+<!--- add BioConductor once up --->
+
+## Usage
+
+```{r, eval=FALSE}
+library(curatedPCaData)
+
+# insert basic example here 
+```

README.md

@@ -1,2 +1,30 @@
-# curatedPCaData
-Curated Prostate Cancer Data R-package / pipelines / workspaces
+
+# curatedPCaData <img src="man/figures/hex.png" align="right" height="139" />
+
+<!-- badges: start -->
+
+<!-- badges: end -->
+
+## Overview
+
+`curatedPCaData` is a collection of publically available and annotated
+data resources concerning prostate cancer.
+
+## Installation
+
+You can install `curatedPCaData` from github with:
+
+``` r
+# install.packages("devtools")
+devtools::install_github("Syksy/curatedPCaData")
+```
+
+<!--- add BioConductor once up --->
+
+## Usage
+
+``` r
+library(curatedPCaData)
+
+# insert basic example here 
+```

curatedPCaData.Rproj

@@ -0,0 +1,17 @@
+Version: 1.0
+
+RestoreWorkspace: Default
+SaveWorkspace: Default
+AlwaysSaveHistory: Default
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: Sweave
+LaTeX: pdfLaTeX
+
+BuildType: Package
+PackageUseDevtools: Yes
+PackageInstallArgs: --no-multiarch --with-keep.source

man/figures/hex_sticker.R

@@ -0,0 +1,12 @@
+library(hexSticker)
+library(magick)
+
+# image from : https://icon-icons.com/icon/tumor-cancer-human-biology-disease-medical-health-cell/133488
+imgurl <- "man/figures/tumor.png"
+
+sticker(imgurl, 
+        package="curatedPCaData", p_size=5, p_color = "#FB62AC", p_y = 0.6,
+        s_x=1, s_y=1.2, s_width=.6,
+        h_fill = "white", h_color = "#2B2671",
+        url = "https://github.com/Syksy/curatedPCaData", u_color = "#FB62AC", u_size = 1,
+        filename="man/figures/hex.png")