From b3211a6cdad0a931ab6ce192ed09f1dd49047a17 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sat, 21 Dec 2024 02:30:23 +0000 Subject: [PATCH] Auto-Generated RSirius Manual --- client-api_r/generated/man/ProjectsApi.Rd | 128 +++++++++--------- .../generated/man/SearchableDatabasesApi.Rd | 86 ++++++++++++ 2 files changed, 150 insertions(+), 64 deletions(-) diff --git a/client-api_r/generated/man/ProjectsApi.Rd b/client-api_r/generated/man/ProjectsApi.Rd index 44daa7aa..e24017ce 100644 --- a/client-api_r/generated/man/ProjectsApi.Rd +++ b/client-api_r/generated/man/ProjectsApi.Rd @@ -20,7 +20,7 @@ Generated by: https://openapi-generator.tech } \examples{ \dontrun{ -#################### CloseProjectSpace #################### +#################### CloseProject #################### library(Rsirius) var_project_id <- "project_id_example" # character | unique name/identifier of the project-space to be closed. @@ -28,10 +28,10 @@ var_project_id <- "project_id_example" # character | unique name/identifier of t #Close project-space and remove it from application api_instance <- rsirius_api$new() -api_instance$projects_api$CloseProjectSpace(var_project_id) +api_instance$projects_api$CloseProject(var_project_id) -#################### CreateProjectSpace #################### +#################### CreateProject #################### library(Rsirius) var_project_id <- "project_id_example" # character | unique name/identifier that shall be used to access the newly created project-space. Must consist only of [a-zA-Z0-9_-]. @@ -42,8 +42,8 @@ var_opt_fields <- c("none") # array[character] | (Optional) api_instance <- rsirius_api$new() # to save the result into a file, simply add the optional `data_file` parameter, e.g. -# result <- api_instance$CreateProjectSpace(var_project_id, path_to_project = var_path_to_project, opt_fields = var_opt_fieldsdata_file = "result.txt") -result <- api_instance$projects_api$CreateProjectSpace(var_project_id, path_to_project = var_path_to_project, opt_fields = var_opt_fields) +# result <- api_instance$CreateProject(var_project_id, path_to_project = var_path_to_project, opt_fields = var_opt_fieldsdata_file = "result.txt") +result <- api_instance$projects_api$CreateProject(var_project_id, path_to_project = var_path_to_project, opt_fields = var_opt_fields) dput(result) @@ -92,7 +92,7 @@ result <- api_instance$projects_api$GetFingerIdData(var_project_id, var_charge) dput(result) -#################### GetProjectSpace #################### +#################### GetProject #################### library(Rsirius) var_project_id <- "project_id_example" # character | unique name/identifier tof the project-space to be accessed. @@ -102,12 +102,12 @@ var_opt_fields <- c("none") # array[character] | (Optional) api_instance <- rsirius_api$new() # to save the result into a file, simply add the optional `data_file` parameter, e.g. -# result <- api_instance$GetProjectSpace(var_project_id, opt_fields = var_opt_fieldsdata_file = "result.txt") -result <- api_instance$projects_api$GetProjectSpace(var_project_id, opt_fields = var_opt_fields) +# result <- api_instance$GetProject(var_project_id, opt_fields = var_opt_fieldsdata_file = "result.txt") +result <- api_instance$projects_api$GetProject(var_project_id, opt_fields = var_opt_fields) dput(result) -#################### GetProjectSpaces #################### +#################### GetProjects #################### library(Rsirius) @@ -115,8 +115,8 @@ library(Rsirius) api_instance <- rsirius_api$new() # to save the result into a file, simply add the optional `data_file` parameter, e.g. -# result <- api_instance$GetProjectSpaces(data_file = "result.txt") -result <- api_instance$projects_api$GetProjectSpaces() +# result <- api_instance$GetProjects(data_file = "result.txt") +result <- api_instance$projects_api$GetProjects() dput(result) @@ -188,7 +188,7 @@ result <- api_instance$projects_api$ImportPreprocessedDataAsJob(var_project_id, dput(result) -#################### OpenProjectSpace #################### +#################### OpenProject #################### library(Rsirius) var_project_id <- "project_id_example" # character | unique name/identifier that shall be used to access the opened project-space. Must consist only of [a-zA-Z0-9_-]. @@ -199,8 +199,8 @@ var_opt_fields <- c("none") # array[character] | (Optional) api_instance <- rsirius_api$new() # to save the result into a file, simply add the optional `data_file` parameter, e.g. -# result <- api_instance$OpenProjectSpace(var_project_id, path_to_project = var_path_to_project, opt_fields = var_opt_fieldsdata_file = "result.txt") -result <- api_instance$projects_api$OpenProjectSpace(var_project_id, path_to_project = var_path_to_project, opt_fields = var_opt_fields) +# result <- api_instance$OpenProject(var_project_id, path_to_project = var_path_to_project, opt_fields = var_opt_fieldsdata_file = "result.txt") +result <- api_instance$projects_api$OpenProject(var_project_id, path_to_project = var_path_to_project, opt_fields = var_opt_fields) dput(result) @@ -217,20 +217,20 @@ dput(result) \subsection{Public methods}{ \itemize{ \item \href{#method-ProjectsApi-new}{\code{ProjectsApi$new()}} -\item \href{#method-ProjectsApi-CloseProjectSpace}{\code{ProjectsApi$CloseProjectSpace()}} -\item \href{#method-ProjectsApi-CloseProjectSpaceWithHttpInfo}{\code{ProjectsApi$CloseProjectSpaceWithHttpInfo()}} -\item \href{#method-ProjectsApi-CreateProjectSpace}{\code{ProjectsApi$CreateProjectSpace()}} -\item \href{#method-ProjectsApi-CreateProjectSpaceWithHttpInfo}{\code{ProjectsApi$CreateProjectSpaceWithHttpInfo()}} +\item \href{#method-ProjectsApi-CloseProject}{\code{ProjectsApi$CloseProject()}} +\item \href{#method-ProjectsApi-CloseProjectWithHttpInfo}{\code{ProjectsApi$CloseProjectWithHttpInfo()}} +\item \href{#method-ProjectsApi-CreateProject}{\code{ProjectsApi$CreateProject()}} +\item \href{#method-ProjectsApi-CreateProjectWithHttpInfo}{\code{ProjectsApi$CreateProjectWithHttpInfo()}} \item \href{#method-ProjectsApi-GetCanopusClassyFireData}{\code{ProjectsApi$GetCanopusClassyFireData()}} \item \href{#method-ProjectsApi-GetCanopusClassyFireDataWithHttpInfo}{\code{ProjectsApi$GetCanopusClassyFireDataWithHttpInfo()}} \item \href{#method-ProjectsApi-GetCanopusNpcData}{\code{ProjectsApi$GetCanopusNpcData()}} \item \href{#method-ProjectsApi-GetCanopusNpcDataWithHttpInfo}{\code{ProjectsApi$GetCanopusNpcDataWithHttpInfo()}} \item \href{#method-ProjectsApi-GetFingerIdData}{\code{ProjectsApi$GetFingerIdData()}} \item \href{#method-ProjectsApi-GetFingerIdDataWithHttpInfo}{\code{ProjectsApi$GetFingerIdDataWithHttpInfo()}} -\item \href{#method-ProjectsApi-GetProjectSpace}{\code{ProjectsApi$GetProjectSpace()}} -\item \href{#method-ProjectsApi-GetProjectSpaceWithHttpInfo}{\code{ProjectsApi$GetProjectSpaceWithHttpInfo()}} -\item \href{#method-ProjectsApi-GetProjectSpaces}{\code{ProjectsApi$GetProjectSpaces()}} -\item \href{#method-ProjectsApi-GetProjectSpacesWithHttpInfo}{\code{ProjectsApi$GetProjectSpacesWithHttpInfo()}} +\item \href{#method-ProjectsApi-GetProject}{\code{ProjectsApi$GetProject()}} +\item \href{#method-ProjectsApi-GetProjectWithHttpInfo}{\code{ProjectsApi$GetProjectWithHttpInfo()}} +\item \href{#method-ProjectsApi-GetProjects}{\code{ProjectsApi$GetProjects()}} +\item \href{#method-ProjectsApi-GetProjectsWithHttpInfo}{\code{ProjectsApi$GetProjectsWithHttpInfo()}} \item \href{#method-ProjectsApi-ImportMsRunData}{\code{ProjectsApi$ImportMsRunData()}} \item \href{#method-ProjectsApi-ImportMsRunDataWithHttpInfo}{\code{ProjectsApi$ImportMsRunDataWithHttpInfo()}} \item \href{#method-ProjectsApi-ImportMsRunDataAsJob}{\code{ProjectsApi$ImportMsRunDataAsJob()}} @@ -239,8 +239,8 @@ dput(result) \item \href{#method-ProjectsApi-ImportPreprocessedDataWithHttpInfo}{\code{ProjectsApi$ImportPreprocessedDataWithHttpInfo()}} \item \href{#method-ProjectsApi-ImportPreprocessedDataAsJob}{\code{ProjectsApi$ImportPreprocessedDataAsJob()}} \item \href{#method-ProjectsApi-ImportPreprocessedDataAsJobWithHttpInfo}{\code{ProjectsApi$ImportPreprocessedDataAsJobWithHttpInfo()}} -\item \href{#method-ProjectsApi-OpenProjectSpace}{\code{ProjectsApi$OpenProjectSpace()}} -\item \href{#method-ProjectsApi-OpenProjectSpaceWithHttpInfo}{\code{ProjectsApi$OpenProjectSpaceWithHttpInfo()}} +\item \href{#method-ProjectsApi-OpenProject}{\code{ProjectsApi$OpenProject()}} +\item \href{#method-ProjectsApi-OpenProjectWithHttpInfo}{\code{ProjectsApi$OpenProjectWithHttpInfo()}} \item \href{#method-ProjectsApi-clone}{\code{ProjectsApi$clone()}} } } @@ -262,12 +262,12 @@ Initialize a new ProjectsApi. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-ProjectsApi-CloseProjectSpace}{}}} -\subsection{Method \code{CloseProjectSpace()}}{ +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ProjectsApi-CloseProject}{}}} +\subsection{Method \code{CloseProject()}}{ Close project-space and remove it from application \subsection{Usage}{ -\if{html}{\out{
}}\preformatted{ProjectsApi$CloseProjectSpace(project_id, ...)}\if{html}{\out{
}} +\if{html}{\out{
}}\preformatted{ProjectsApi$CloseProject(project_id, ...)}\if{html}{\out{
}} } \subsection{Arguments}{ @@ -284,12 +284,12 @@ void } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-ProjectsApi-CloseProjectSpaceWithHttpInfo}{}}} -\subsection{Method \code{CloseProjectSpaceWithHttpInfo()}}{ +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ProjectsApi-CloseProjectWithHttpInfo}{}}} +\subsection{Method \code{CloseProjectWithHttpInfo()}}{ Close project-space and remove it from application \subsection{Usage}{ -\if{html}{\out{
}}\preformatted{ProjectsApi$CloseProjectSpaceWithHttpInfo(project_id, ...)}\if{html}{\out{
}} +\if{html}{\out{
}}\preformatted{ProjectsApi$CloseProjectWithHttpInfo(project_id, ...)}\if{html}{\out{
}} } \subsection{Arguments}{ @@ -306,12 +306,12 @@ API response (void) with additional information such as HTTP status code, header } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-ProjectsApi-CreateProjectSpace}{}}} -\subsection{Method \code{CreateProjectSpace()}}{ +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ProjectsApi-CreateProject}{}}} +\subsection{Method \code{CreateProject()}}{ Create and open a new project-space at given location and make it accessible via the given projectId. \subsection{Usage}{ -\if{html}{\out{
}}\preformatted{ProjectsApi$CreateProjectSpace( +\if{html}{\out{
}}\preformatted{ProjectsApi$CreateProject( project_id, path_to_project = NULL, opt_fields = list("none"), @@ -340,12 +340,12 @@ ProjectInfo } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-ProjectsApi-CreateProjectSpaceWithHttpInfo}{}}} -\subsection{Method \code{CreateProjectSpaceWithHttpInfo()}}{ +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ProjectsApi-CreateProjectWithHttpInfo}{}}} +\subsection{Method \code{CreateProjectWithHttpInfo()}}{ Create and open a new project-space at given location and make it accessible via the given projectId. \subsection{Usage}{ -\if{html}{\out{
}}\preformatted{ProjectsApi$CreateProjectSpaceWithHttpInfo( +\if{html}{\out{
}}\preformatted{ProjectsApi$CreateProjectWithHttpInfo( project_id, path_to_project = NULL, opt_fields = list("none"), @@ -545,12 +545,12 @@ API response (character) with additional information such as HTTP status code, h } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-ProjectsApi-GetProjectSpace}{}}} -\subsection{Method \code{GetProjectSpace()}}{ +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ProjectsApi-GetProject}{}}} +\subsection{Method \code{GetProject()}}{ Get project space info by its projectId. \subsection{Usage}{ -\if{html}{\out{
}}\preformatted{ProjectsApi$GetProjectSpace( +\if{html}{\out{
}}\preformatted{ProjectsApi$GetProject( project_id, opt_fields = list("none"), data_file = NULL, @@ -576,12 +576,12 @@ ProjectInfo } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-ProjectsApi-GetProjectSpaceWithHttpInfo}{}}} -\subsection{Method \code{GetProjectSpaceWithHttpInfo()}}{ +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ProjectsApi-GetProjectWithHttpInfo}{}}} +\subsection{Method \code{GetProjectWithHttpInfo()}}{ Get project space info by its projectId. \subsection{Usage}{ -\if{html}{\out{
}}\preformatted{ProjectsApi$GetProjectSpaceWithHttpInfo( +\if{html}{\out{
}}\preformatted{ProjectsApi$GetProjectWithHttpInfo( project_id, opt_fields = list("none"), data_file = NULL, @@ -607,12 +607,12 @@ API response (ProjectInfo) with additional information such as HTTP status code, } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-ProjectsApi-GetProjectSpaces}{}}} -\subsection{Method \code{GetProjectSpaces()}}{ +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ProjectsApi-GetProjects}{}}} +\subsection{Method \code{GetProjects()}}{ List opened project spaces. \subsection{Usage}{ -\if{html}{\out{
}}\preformatted{ProjectsApi$GetProjectSpaces(data_file = NULL, ...)}\if{html}{\out{
}} +\if{html}{\out{
}}\preformatted{ProjectsApi$GetProjects(data_file = NULL, ...)}\if{html}{\out{
}} } \subsection{Arguments}{ @@ -629,12 +629,12 @@ array[ProjectInfo] } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-ProjectsApi-GetProjectSpacesWithHttpInfo}{}}} -\subsection{Method \code{GetProjectSpacesWithHttpInfo()}}{ +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ProjectsApi-GetProjectsWithHttpInfo}{}}} +\subsection{Method \code{GetProjectsWithHttpInfo()}}{ List opened project spaces. \subsection{Usage}{ -\if{html}{\out{
}}\preformatted{ProjectsApi$GetProjectSpacesWithHttpInfo(data_file = NULL, ...)}\if{html}{\out{
}} +\if{html}{\out{
}}\preformatted{ProjectsApi$GetProjectsWithHttpInfo(data_file = NULL, ...)}\if{html}{\out{
}} } \subsection{Arguments}{ @@ -947,12 +947,12 @@ API response (Job) with additional information such as HTTP status code, headers } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-ProjectsApi-OpenProjectSpace}{}}} -\subsection{Method \code{OpenProjectSpace()}}{ +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ProjectsApi-OpenProject}{}}} +\subsection{Method \code{OpenProject()}}{ Open an existing project-space and make it accessible via the given projectId. \subsection{Usage}{ -\if{html}{\out{
}}\preformatted{ProjectsApi$OpenProjectSpace( +\if{html}{\out{
}}\preformatted{ProjectsApi$OpenProject( project_id, path_to_project = NULL, opt_fields = list("none"), @@ -981,12 +981,12 @@ ProjectInfo } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-ProjectsApi-OpenProjectSpaceWithHttpInfo}{}}} -\subsection{Method \code{OpenProjectSpaceWithHttpInfo()}}{ +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ProjectsApi-OpenProjectWithHttpInfo}{}}} +\subsection{Method \code{OpenProjectWithHttpInfo()}}{ Open an existing project-space and make it accessible via the given projectId. \subsection{Usage}{ -\if{html}{\out{
}}\preformatted{ProjectsApi$OpenProjectSpaceWithHttpInfo( +\if{html}{\out{
}}\preformatted{ProjectsApi$OpenProjectWithHttpInfo( project_id, path_to_project = NULL, opt_fields = list("none"), diff --git a/client-api_r/generated/man/SearchableDatabasesApi.Rd b/client-api_r/generated/man/SearchableDatabasesApi.Rd index 7e0af777..d9cc8aa0 100644 --- a/client-api_r/generated/man/SearchableDatabasesApi.Rd +++ b/client-api_r/generated/man/SearchableDatabasesApi.Rd @@ -103,6 +103,22 @@ result <- api_instance$searchable_databases_api$GetIncludedDatabases(include_sta dput(result) +#################### ImportIntoDatabase #################### + +library(Rsirius) +var_database_id <- "database_id_example" # character | database to import into +var_buffer_size <- 1000 # integer | (Optional) +var_input_files <- c(123) # array[data.frame] | (Optional) + +#Start import of structure and spectra files into the specified database. +api_instance <- rsirius_api$new() + +# to save the result into a file, simply add the optional `data_file` parameter, e.g. +# result <- api_instance$ImportIntoDatabase(var_database_id, buffer_size = var_buffer_size, input_files = var_input_filesdata_file = "result.txt") +result <- api_instance$searchable_databases_api$ImportIntoDatabase(var_database_id, buffer_size = var_buffer_size, input_files = var_input_files) +dput(result) + + #################### RemoveDatabase #################### library(Rsirius) @@ -153,6 +169,8 @@ dput(result) \item \href{#method-SearchableDatabasesApi-GetDatabasesWithHttpInfo}{\code{SearchableDatabasesApi$GetDatabasesWithHttpInfo()}} \item \href{#method-SearchableDatabasesApi-GetIncludedDatabases}{\code{SearchableDatabasesApi$GetIncludedDatabases()}} \item \href{#method-SearchableDatabasesApi-GetIncludedDatabasesWithHttpInfo}{\code{SearchableDatabasesApi$GetIncludedDatabasesWithHttpInfo()}} +\item \href{#method-SearchableDatabasesApi-ImportIntoDatabase}{\code{SearchableDatabasesApi$ImportIntoDatabase()}} +\item \href{#method-SearchableDatabasesApi-ImportIntoDatabaseWithHttpInfo}{\code{SearchableDatabasesApi$ImportIntoDatabaseWithHttpInfo()}} \item \href{#method-SearchableDatabasesApi-RemoveDatabase}{\code{SearchableDatabasesApi$RemoveDatabase()}} \item \href{#method-SearchableDatabasesApi-RemoveDatabaseWithHttpInfo}{\code{SearchableDatabasesApi$RemoveDatabaseWithHttpInfo()}} \item \href{#method-SearchableDatabasesApi-UpdateDatabase}{\code{SearchableDatabasesApi$UpdateDatabase()}} @@ -524,6 +542,74 @@ API response (array[SearchableDatabase]) with additional information such as HTT } } \if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-SearchableDatabasesApi-ImportIntoDatabase}{}}} +\subsection{Method \code{ImportIntoDatabase()}}{ +Start import of structure and spectra files into the specified database. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{SearchableDatabasesApi$ImportIntoDatabase( + database_id, + buffer_size = 1000, + input_files = NULL, + data_file = NULL, + ... +)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{database_id}}{database to import into} + +\item{\code{buffer_size}}{(optional) No description (default value: 1000)} + +\item{\code{input_files}}{(optional) No description} + +\item{\code{data_file}}{(optional) name of the data file to save the result} + +\item{\code{...}}{Other optional arguments} +} +\if{html}{\out{
}} +} +\subsection{Returns}{ +SearchableDatabase +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-SearchableDatabasesApi-ImportIntoDatabaseWithHttpInfo}{}}} +\subsection{Method \code{ImportIntoDatabaseWithHttpInfo()}}{ +Start import of structure and spectra files into the specified database. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{SearchableDatabasesApi$ImportIntoDatabaseWithHttpInfo( + database_id, + buffer_size = 1000, + input_files = NULL, + data_file = NULL, + ... +)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{database_id}}{database to import into} + +\item{\code{buffer_size}}{(optional) No description (default value: 1000)} + +\item{\code{input_files}}{(optional) No description} + +\item{\code{data_file}}{(optional) name of the data file to save the result} + +\item{\code{...}}{Other optional arguments} +} +\if{html}{\out{
}} +} +\subsection{Returns}{ +API response (SearchableDatabase) with additional information such as HTTP status code, headers +} +} +\if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-SearchableDatabasesApi-RemoveDatabase}{}}} \subsection{Method \code{RemoveDatabase()}}{