From b561098f197c177895987516df763857a09871d9 Mon Sep 17 00:00:00 2001 From: jbedia Date: Fri, 21 Sep 2018 13:58:20 +0200 Subject: [PATCH] Doc update --- DESCRIPTION | 2 +- NAMESPACE | 9 +++++++++ man/qa4seas.metaclipR.Rd | 22 ++++++++++++++++++++++ 3 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 man/qa4seas.metaclipR.Rd diff --git a/DESCRIPTION b/DESCRIPTION index 6ca9070..9a518d6 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -10,7 +10,7 @@ Imports: yaml Title: Extend METACLIP to the QA4Seas prototype Version: 0.1.0 -Date: 2018-09-16 +Date: 2018-09-21 Authors@R: as.person(c( "Predictia [cph]", "JoaquĆ­n Bedia [aut, cre]", diff --git a/NAMESPACE b/NAMESPACE index b7d457c..91d4419 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1,14 +1,23 @@ # Generated by roxygen2: do not edit by hand +export(qa4seas.metaclipR) importFrom(igraph,add_edges) importFrom(igraph,add_vertices) importFrom(igraph,make_empty_graph) importFrom(magrittr,"%>%") importFrom(metaclipR,getNodeIndexbyName) +importFrom(metaclipR,graph2json) importFrom(metaclipR,metaclip.graph.Command) importFrom(metaclipR,metaclipR.Aggregation) +importFrom(metaclipR,metaclipR.Anomaly) +importFrom(metaclipR,metaclipR.BiasCorrection) +importFrom(metaclipR,metaclipR.ClimateIndex) importFrom(metaclipR,metaclipR.Dataset) importFrom(metaclipR,metaclipR.Ensemble) +importFrom(metaclipR,metaclipR.Interpolation) +importFrom(metaclipR,metaclipR.SkillMap) +importFrom(metaclipR,metaclipR.SpatialExtent) +importFrom(metaclipR,metaclipR.Validation) importFrom(metaclipR,my_add_vertices) importFrom(metaclipR,my_union_graph) importFrom(metaclipR,randomName) diff --git a/man/qa4seas.metaclipR.Rd b/man/qa4seas.metaclipR.Rd new file mode 100644 index 0000000..cec3465 --- /dev/null +++ b/man/qa4seas.metaclipR.Rd @@ -0,0 +1,22 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/qa4seas.metaclipR.R +\name{qa4seas.metaclipR} +\alias{qa4seas.metaclipR} +\title{QA4Seas prototype metaclip launcher} +\usage{ +qa4seas.metaclipR(parameter.file, pkg = "QA4Seas-prototype", + v = "1.0.1", out.dir) +} +\arguments{ +\item{parameter.file}{Input yaml parameter file} + +\item{pkg}{Software package. Default to \code{"QA4Seas-prototype"}, which has an individual description in the datasource ontology.} + +\item{v}{Software package version character string. Default to \code{"1.0.1"}} + +\item{out.dir}{Full path to the output directory the output json files are to be stored} +} +\description{ +Given a prototype input yaml file, parses the parameters to yield json files with metadata description for + the outcomes generated +}