Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify the doc of gen_usms_xml2txt #98

Open
timflutre opened this issue Jun 13, 2024 · 1 comment
Open

Clarify the doc of gen_usms_xml2txt #98

timflutre opened this issue Jun 13, 2024 · 1 comment

Comments

@timflutre
Copy link
Contributor

Clarify the doc of gen_usms_xml2txt

Expected Behavior

The doc of argument javastics should be "Path of JavaSTICS (needed if the JavaSTICS converter is used, java_converter set to TRUE in inputs, otherwise needed to retrieve some extra files)".

Current Behavior

The current doc of argument javastics is "Path of JavaSTICS. Optional (needed if the JavaSTICS converter is used, java_converter set to TRUE in inputs)".

Failure Information (for bugs)

Currently, if javastics is not set and the file tempopar.sti is missing, this file will not be retrieved and any subsequent call to stics_wrapper will fail.

Context

Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions.

  • R version: 4.2.2
  • RStudio version: NA
  • OS: Debian
  • Package dependencies version: SticsRFiles 1.3.0
@plecharpent
Copy link
Contributor

Hi @timflutre,

You are right the documentation and vignette/examples have to be updated and completed.

Without using the JavaStics converter, the param_gen.xml and param_newform.xml files must exist in the workspace folder to obtain the text equivalent files.

Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants