From 9603114e25e6f868cf93fd15b62b7fe42324c711 Mon Sep 17 00:00:00 2001 From: Bastiaan Quast Date: Fri, 17 Jan 2020 12:19:01 +0100 Subject: [PATCH] redo documentation, bump version, use https urls --- DESCRIPTION | 8 ++++---- R/learNN.R | 2 +- R/learn_bp.R | 4 ++-- R/learn_do.R | 4 ++-- R/learn_gd.R | 4 ++-- man/learn_bp.Rd | 5 ++--- man/learn_bp11.Rd | 1 - man/learn_do.Rd | 5 ++--- man/learn_do15.Rd | 1 - man/learn_gd.Rd | 5 ++--- man/learn_gd13.Rd | 1 - man/learnn.Rd | 4 +--- 12 files changed, 18 insertions(+), 26 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 89528cb..09962d3 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,12 +1,12 @@ Package: learNN Title: Examples of Neural Networks -Version: 0.2.0.9000 +Version: 0.5.0 Authors@R: person("Bastiaan", "Quast", email = "bquast@gmail.com", role = c("aut", "cre")) Description: Implementations of several basic neural network concepts in R, as - based on posts on \url{http://qua.st/}. + based on posts on \url{https://qua.st/}. Depends: - R (>= 2.10.0) + R (>= 3.6.0) License: GPL-3 Suggests: testthat -RoxygenNote: 5.0.0 +RoxygenNote: 7.0.2 diff --git a/R/learNN.R b/R/learNN.R index af1b279..27a84df 100644 --- a/R/learNN.R +++ b/R/learNN.R @@ -4,5 +4,5 @@ #' Bastiaan Quast \email{bquast@@gmail.com} #' @title Learn Neural Networks #' @description Implementations of several basic neural network concepts in R, -#' as based on posts on \url{http://qua.st/}. +#' as based on posts on \url{https://qua.st/}. NULL diff --git a/R/learn_bp.R b/R/learn_bp.R index 45e78b9..a73d2dd 100644 --- a/R/learn_bp.R +++ b/R/learn_bp.R @@ -4,8 +4,8 @@ #' @param X input data #' @param y output data #' @importFrom stats runif -#' @references \url{http://qua.st/handcoding-neural-network/} -#' \url{http://iamtrask.github.io/2015/07/12/basic-python-network/} +#' @references \url{https://qua.st/handcoding-neural-network/} +#' \url{https://iamtrask.github.io/2015/07/12/basic-python-network/} #' @export #' @examples #' # create data diff --git a/R/learn_do.R b/R/learn_do.R index 90c92de..9abe579 100644 --- a/R/learn_do.R +++ b/R/learn_do.R @@ -9,8 +9,8 @@ #' @importFrom stats rbinom #' @importFrom stats runif #' @export -#' @references \url{http://qua.st/handcoding-dropout/} -#' \url{http://iamtrask.github.io/2015/07/28/dropout/} +#' @references \url{https://qua.st/handcoding-dropout/} +#' \url{https://iamtrask.github.io/2015/07/28/dropout/} #' @examples #' # construct data #' X = matrix(c(0,0,1,0,1,1,1,0,1,1,1,1), nrow=4, byrow=TRUE) diff --git a/R/learn_gd.R b/R/learn_gd.R index 87d7dbb..bb2c3a0 100644 --- a/R/learn_gd.R +++ b/R/learn_gd.R @@ -6,8 +6,8 @@ #' @param hiddenSize size of the hidden layer #' @importFrom stats runif #' @export -#' @references \url{http://qua.st/handcoding-gradient-descent/} -#' \url{http://iamtrask.github.io/2015/07/27/python-network-part2/} +#' @references \url{https://qua.st/handcoding-gradient-descent/} +#' \url{https://iamtrask.github.io/2015/07/27/python-network-part2/} #' @examples #' # input dataset #' X = matrix(c(0,0,1, diff --git a/man/learn_bp.Rd b/man/learn_bp.Rd index 3c30361..11731f5 100644 --- a/man/learn_bp.Rd +++ b/man/learn_bp.Rd @@ -33,7 +33,6 @@ learn_bp(X, y) \references{ \url{http://qua.st/handcoding-neural-network/} -\url{http://qua.st/handcoding-neural-network/} -\url{http://iamtrask.github.io/2015/07/12/basic-python-network/} +\url{https://qua.st/handcoding-neural-network/} +\url{https://iamtrask.github.io/2015/07/12/basic-python-network/} } - diff --git a/man/learn_bp11.Rd b/man/learn_bp11.Rd index 1c8ddf4..7b23831 100644 --- a/man/learn_bp11.Rd +++ b/man/learn_bp11.Rd @@ -33,4 +33,3 @@ syn1 \seealso{ \code{\link{learn_bp}} } - diff --git a/man/learn_do.Rd b/man/learn_do.Rd index 0e3e2c6..9b416ed 100644 --- a/man/learn_do.Rd +++ b/man/learn_do.Rd @@ -41,7 +41,6 @@ synapse_0 synapse_1 } \references{ -\url{http://qua.st/handcoding-dropout/} -\url{http://iamtrask.github.io/2015/07/28/dropout/} +\url{https://qua.st/handcoding-dropout/} +\url{https://iamtrask.github.io/2015/07/28/dropout/} } - diff --git a/man/learn_do15.Rd b/man/learn_do15.Rd index bb85d8f..0ddec75 100644 --- a/man/learn_do15.Rd +++ b/man/learn_do15.Rd @@ -47,4 +47,3 @@ synapse_1 \seealso{ \code{\link{learn_do}} } - diff --git a/man/learn_gd.Rd b/man/learn_gd.Rd index 931031f..41b7fcf 100644 --- a/man/learn_gd.Rd +++ b/man/learn_gd.Rd @@ -44,7 +44,6 @@ hiddenSize = 32 learn_gd(X, y, alpha, hiddenSize) } \references{ -\url{http://qua.st/handcoding-gradient-descent/} -\url{http://iamtrask.github.io/2015/07/27/python-network-part2/} +\url{https://qua.st/handcoding-gradient-descent/} +\url{https://iamtrask.github.io/2015/07/27/python-network-part2/} } - diff --git a/man/learn_gd13.Rd b/man/learn_gd13.Rd index cd40e6a..f768ce8 100644 --- a/man/learn_gd13.Rd +++ b/man/learn_gd13.Rd @@ -35,4 +35,3 @@ learn_gd13(X, y, alpha, hidden_dim) \seealso{ \code{\link{learn_gd}} } - diff --git a/man/learnn.Rd b/man/learnn.Rd index da577df..f39f26e 100644 --- a/man/learnn.Rd +++ b/man/learnn.Rd @@ -3,13 +3,11 @@ \docType{package} \name{learnn} \alias{learnn} -\alias{learnn-package} \title{Learn Neural Networks} \description{ Implementations of several basic neural network concepts in R, -as based on posts on \url{http://qua.st/}. +as based on posts on \url{https://qua.st/}. } \author{ Bastiaan Quast \email{bquast@gmail.com} } -