Added documentation

man/add_project.Rd

@@ -0,0 +1,25 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/pm.R
+\name{add_project}
+\alias{add_project}
+\title{Add a project}
+\usage{
+add_project(project_id, project_name, host = "", admin = "", pass = "")
+}
+\arguments{
+\item{project_id}{The desired project id}
+
+\item{project_name}{The desired project name}
+
+\item{host}{Address of the host, defaults to 127.0.0.1}
+
+\item{admin}{Name of the database admin account}
+
+\item{pass}{Password of the database admin account}
+}
+\description{
+Add a project with its id, path and name in the hive
+}
+\details{
+Also create a specific database for this project
+}

man/delete_project.Rd

@@ -0,0 +1,20 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/pm.R
+\name{delete_project}
+\alias{delete_project}
+\title{Delete a project}
+\usage{
+delete_project(project_id, host = "", admin = "", pass = "")
+}
+\arguments{
+\item{project_id}{The project to delete}
+
+\item{host}{Address of the host, defaults to 127.0.0.1}
+
+\item{admin}{Name of the database admin account}
+
+\item{pass}{Password of the database admin account}
+}
+\description{
+Delete a project from the hive
+}

man/get_domain.Rd

@@ -0,0 +1,21 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/pm.R
+\name{get_domain}
+\alias{get_domain}
+\title{Get the domain}
+\usage{
+get_domain(host = "", admin = "", pass = "")
+}
+\arguments{
+\item{host}{The host to connect to}
+
+\item{admin}{Name of the database admin account}
+
+\item{pass}{Password of the database admin account}
+}
+\value{
+The domain id and name
+}
+\description{
+Get the domain id of the instance
+}

man/list_projects.Rd

@@ -0,0 +1,21 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/pm.R
+\name{list_projects}
+\alias{list_projects}
+\title{List projects}
+\usage{
+list_projects(host = "", admin = "", pass = "")
+}
+\arguments{
+\item{host}{Address of the host, defaults to 127.0.0.1}
+
+\item{admin}{Name of the database admin account}
+
+\item{pass}{Password of the database admin account}
+}
+\value{
+The list of projects
+}
+\description{
+List available projects in the hive
+}