GH-38216: [R] open_dataset(format = "json") not documented

[Divyansh200102]

fixes #38216

• Closes: [R] open_dataset(format = "json") not documented #38216

[github-actions]

Thanks for opening a pull request!

If this is not a minor PR. Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose

Opening GitHub issues ahead of time contributes to the Openness of the Apache Arrow project.

Then could you also rename the pull request title in the following format?

GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}

or

MINOR: [${COMPONENT}] ${SUMMARY}

In the case of PARQUET issues on JIRA the title also supports:

PARQUET-${JIRA_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}

See also:

• Other pull requests
• Contribution Guidelines - How to contribute patches

[github-actions]

⚠️ GitHub issue #38216 has been automatically assigned in GitHub to PR creator.

[thisisnic]

Thanks for making this PR, @Divyansh200102! A couple of things to suggest:

1. The ".Rd" files in the package are automatically generated from the Roxygen headers above the functions in the package, and so the change needs to be made by adding the documentation in line 115 in dataset.R:

arrow/r/R/dataset.R

Lines 114 to 115 in 4bf777a

	#' * "tsv", equivalent to passing `format = "text", delimiter = "\t"`
	#'

Then, if you run devtools::document() in R the change in open_dataset.Rd will be automatically generated. (if you're only making the changes in the GitHub editor, let me know and I can run devtools::document() myself and push the change for you)

2. We only currently support newline-delimited JSON (aka ND-JSON), so we should be clear about that so that users don't mistakenly think we support all JSON

[Divyansh200102]

is it fine now? and for some reason i am not able to setup the r so can you run devtools::document() in R and push the changes in open_dataset.Rd in yourself

[thisisnic]

Great, the comment is in the right file! Just needs updating to refer to newline-delimited JSON rather than just JSON.

[jonkeane]

@github-actions autotune

[jonkeane]

I tried to fix the docs on using out bot, but looks like the github bot can’t push to this fork: https://github.com/apache/arrow/actions/runs/6550133348/job/17788582932#step:13:8

I'm not sure if this is something you've configured @Divyansh200102 to disallow pushes to your fork from upstream, or if it's something that is wrong with the bot generally.

[Divyansh200102]

I tried to fix the docs on using out bot, but looks like the github bot can’t push to this fork: https://github.com/apache/arrow/actions/runs/6550133348/job/17788582932#step:13:8

I'm not sure if this is something you've configured @Divyansh200102 to disallow pushes to your fork from upstream, or if it's something that is wrong with the bot generally.

shall i create a new pull request??

[jonkeane]

shall i create a new pull request??

Nope, don't worry about it — I pulled it locally and updated them. Once the CI is green I'll approve + merge.

Thanks for your contribution!

[conbench-apache-arrow]

After merging your PR, Conbench analyzed the 6 benchmarking runs that have been run so far on merge-commit ac581fd.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.