Skip to content

Commit

Permalink
Add fair warning for users (#23)
Browse files Browse the repository at this point in the history
  • Loading branch information
kuriwaki committed Jun 10, 2022
1 parent e2138fd commit d8543c0
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 8 deletions.
8 changes: 5 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,9 @@ attr(nlsw_original$race, "labels") # original dta has value labels



### Data Archiving
### Data Upload and Archiving

**Note**: _There are known issues to using to dataverse creation and dataset addition functionalities listed here. `add_dataset_file()` appears stable as of again as of v0.3.11. One possible workaround is to mix the two workflows described above (See e.g. this [comment](https://github.com/IQSS/dataverse-client-r/issues/82#issuecomment-1094623268))._

Dataverse provides two - basically unrelated - workflows for managing (adding, documenting, and publishing) datasets. The first workflow is called the "native" API and uses `create_dataset` to make an empty dataset and adds files by `add_dataset_file` by taking a path to a dataset that is located in your local. Through the native API it is possible to update a dataset by modifying its metadata with `update_dataset()` or file contents using `update_dataset_file()` and then republish a new version using `publish_dataset()`.

Expand Down Expand Up @@ -193,9 +195,9 @@ list_datasets("<mydataverse>")

### Limitations

The R client is current stable for data search and download. For more extensive features of _uploading_ and maintaining data, see [pyDataverse](https://pydataverse.readthedocs.io/en/latest/).
The R client is current stable for data search and download. For more extensive features of _uploading_ and maintaining data, see the issues reported in the Github repository. You may need to use alternative methods, such as working on the Dataverse GUI directly or using [pyDataverse](https://pydataverse.readthedocs.io/en/latest/).

Currently, functions related to user management and permissions - are not currently exported in the package (but are drafted in the source code).
Functions related to user management and permissions are currently not exported in the package (but are drafted in the source code).



Expand Down
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,13 @@ attr(nlsw_original$race, "labels") # original dta has value labels
## white black other
## 1 2 3

### Data Archiving
### Data Upload and Archiving

**Note**: *There are known issues to using to dataverse creation and
dataset addition functionalities listed here. `add_dataset_file()`
appears stable as of again as of v0.3.11. One possible workaround is to
mix the two workflows described above (See e.g. this
[comment](https://github.com/IQSS/dataverse-client-r/issues/82#issuecomment-1094623268)).*

Dataverse provides two - basically unrelated - workflows for managing
(adding, documenting, and publishing) datasets. The first workflow is
Expand Down Expand Up @@ -254,12 +260,13 @@ list_datasets("<mydataverse>")
### Limitations

The R client is current stable for data search and download. For more
extensive features of *uploading* and maintaining data, see
extensive features of *uploading* and maintaining data, see the issues
reported in the Github repository. You may need to use alternative
methods, such as working on the Dataverse GUI directly or using
[pyDataverse](https://pydataverse.readthedocs.io/en/latest/).

Currently, functions related to user management and permissions - are
not currently exported in the package (but are drafted in the source
code).
Functions related to user management and permissions are currently not
exported in the package (but are drafted in the source code).

### Related Software

Expand Down

0 comments on commit d8543c0

Please sign in to comment.