try to add documentation with roxygen2

DESCRIPTION

@@ -10,3 +10,4 @@ License: MIT License
 Encoding: UTF-8
 Depends: R (>= 3.5), rvest, httr, getPass
 Collate: IRICData-class.R
+RoxygenNote: 6.1.1

NAMESPACE

-# Generated by roxygen2: fake comment so roxygen2 overwrites silently.
-exportPattern("^[^\\.]")
+# Generated by roxygen2: do not edit by hand
+

R/IRICData-class.R

+#' '### =========================================================================
+#' ### IRICData objects
+#' ### -------------------------------------------------------------------------
+#' ###
+#' ### The Assays API consists of:
+#' ###   (a) The IRICData() constructor function.
+#' ###   (b) The open_session() method function.
+#' ###   (c) The DL_dataset() method function.
+#' ###
+
+#' ### - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+#' ### IRICData class
+#' ###
+
 IRICData <- setClass(
   # Set the name for the class
   "IRICData",
@@ -23,6 +37,10 @@ IRICData <- setClass(
   }
 )
 
+#' ### - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+#' ### Accessors
+#' ###
+
 setGeneric(
   name="open_session",
   def=function(object){
@@ -43,6 +61,10 @@ setMethod(
   }
 )
 
+#' ### - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+#' ### Accessors
+#' ###
+
 setGeneric(
   name="DL_dataset",
   def=function(object, session, id_dataset, path_out){

man/DL_dataset.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/IRICData-class.R
+\name{DL_dataset}
+\alias{DL_dataset}
+\title{### - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+### Accessors
+###}
+\usage{
+DL_dataset(object, session, id_dataset, path_out)
+}
+\description{
+### - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+### Accessors
+###
+}

man/IRICData-class.Rd

-\name{IRICData-class}
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/IRICData-class.R
 \docType{class}
-
-% Class
-\alias{class:IRICData}
+\name{IRICData-class}
 \alias{IRICData-class}
-
-% Accessors
-\alias{open_session,IRICData-method}
-\alias{DL_dataset,IRICData-method}
-
-\title{IRICData objects}
-
+\alias{IRICData}
+\title{'### =========================================================================
+### IRICData objects
+### -------------------------------------------------------------------------
+###
+### The Assays API consists of:
+###   (a) The IRICData() constructor function.
+###   (b) The open_session() method function.
+###   (c) The DL_dataset() method function.
+###
+### - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+### IRICData class
+###}
 \description{
-  The IRICData class and its methods is API to IRIC data which allow to
-  download files from dataset.
-}
-
-\details{
-  The IRIC_data API consists of:
-  \itemize{
-    \item (a) The \code{IRICData()} constructor function.
-    \item (b) The \code{open_session()} method function.
-    \item (c) The \code{DL_dataset()} method function.
-  }
-}
-\author{Eric audemard}
-
-\examples{
-  library(Riricdata)
-  # Create IRICData object
-  #   By default IRIC_data url will be "https://thepond.bioinfo.iric.ca"
-  #   You can change it by adding url="your_url"
-  IData = IRICData(user="your_SIM_ids")
-
-  # Open a session
-  #   This cmd will ask your pwd
-  IData_session = open_session(IData)
-
-  # To downolad a dataset
-  DL_dataset(IData, IData_session, [the_dataset_id_you_want], "directory/output/path")
+'### =========================================================================
+### IRICData objects
+### -------------------------------------------------------------------------
+###
+### The Assays API consists of:
+###   (a) The IRICData() constructor function.
+###   (b) The open_session() method function.
+###   (c) The DL_dataset() method function.
+###
+### - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+### IRICData class
+###
 }

man/open_session.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/IRICData-class.R
+\name{open_session}
+\alias{open_session}
+\title{### - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+### Accessors
+###}
+\usage{
+open_session(object)
+}
+\description{
+### - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+### Accessors
+###
+}