mediwikir class+doc

.Rbuildignore

+^.*\.Rproj$
+^\.Rproj\.user$

.gitignore

+.Rproj.user
+.Rhistory
+.RData
+.Ruserdata
+R/hello.R

DESCRIPTION

+Package: mediawikir
+Type: Package
+Title: Connects to a mediawiki instance and writes in it what you want
+Version: 0.1.0
+Author: Mathieu Loiseau
+Maintainer: Mathieu Loiseau <loiseaum@univ-grenoble-alpes.fr>
+Description: It can be used to post the output of an R script directly to a mediawiki instance
+License: MIT
+Encoding: UTF-8
+LazyData: true
+RoxygenNote: 6.0.1

NAMESPACE

+# Generated by roxygen2: do not edit by hand
+

R/class.R

+#'A Mediawikir controller serves to connect to a mediawiki API as a registered user in order to edit automatically certain documents based on R scripts
+#'
+#'@slot url the mediawiki instance base url
+#'@slot auth_token the current token used to edit the wiki (cf. https://www.mediawiki.org/wiki/Manual:Edit_token)
+setClass("Mediawikir", representation(url = "character", auth_token = "character"))
+
+#'Creates a new Mediawikir object instance
+#'
+#'@param instance_url the base url for the mediawiki instance in which one wants to store R output
+#'@param user the user to which all changes to the wiki will be credited
+#'@param pass the user's password
+#'@examples
+#' new("Mediawikir", "http://wiki.example.com", "admin", "theadmin'spassword")
+setMethod("initialize", "Mediawikir", function (.Object, instance_url, user, pass){
+  .Object@url <- instance_url
+  .Object@auth_token <- paste(user, pass, sep=" / ")
+  return(.Object)
+})

man/Mediawikir-class.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/class.R
+\docType{class}
+\name{Mediawikir-class}
+\alias{Mediawikir-class}
+\title{A Mediawikir controller serves to connect to a mediawiki API as a registered user in order to edit automatically certain documents based on R scripts}
+\description{
+A Mediawikir controller serves to connect to a mediawiki API as a registered user in order to edit automatically certain documents based on R scripts
+}
+\section{Slots}{
+
+\describe{
+\item{\code{url}}{the mediawiki instance base url}
+
+\item{\code{auth_token}}{the current token used to edit the wiki (cf. https://www.mediawiki.org/wiki/Manual:Edit_token)}
+}}
+

man/initialize-Mediawikir-method.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/class.R
+\docType{methods}
+\name{initialize,Mediawikir-method}
+\alias{initialize,Mediawikir-method}
+\title{Creates a new Mediawikir object instance}
+\usage{
+\S4method{initialize}{Mediawikir}(.Object, instance_url, user, pass)
+}
+\arguments{
+\item{instance_url}{the base url for the mediawiki instance in which one wants to store R output}
+
+\item{user}{the user to which all changes to the wiki will be credited}
+
+\item{pass}{the user's password}
+}
+\description{
+Creates a new Mediawikir object instance
+}
+\examples{
+new("Mediawikir", "http://wiki.example.com", "admin", "theadmin'spassword")
+}

mediawikir.Rproj

+Version: 1.0
+
+RestoreWorkspace: Default
+SaveWorkspace: Default
+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