openwashdata / washr

An R package to make publishing openwashdata resources easier
https://openwashdata.github.io/washr/
GNU General Public License v3.0
1 stars 0 forks source link

Review Title, Description, License and Vignette #10

Closed mianzg closed 3 months ago

mianzg commented 4 months ago

@larnsce I started to prepare the first release for CRAN. I would like to agree on the DESCRIPTION file and have a review on the vignette.

larnsce commented 3 months ago

Thank you, @mianzg. My comments:

DESCRIPTION

It provides templates to reduce manual editing for tidy data exporting, README writing, pkgdown configuration and content.

Vignette

Once you initialize an R package named with fssample with devtools

The step of initializing fssample with devtools needs to be documented first.

After executing the last a few lines in data-processing.R, namely,

Revise this sentence. It's difficult to understand.

Go to R/ and fill in the title and description for the dataset.

This needs more information.

Communicate dataset

This section is not complete. It needs to be split into several steps that explain in more detail what the user is supposed to do.

mianzg commented 3 months ago

@larnsce Title, URL, and Description are modified.

Should we exclude "Communicate dataset" in the get-started vignette?

larnsce commented 3 months ago

No, keep that section. It's the most valuable part from an outsider data curation perspective.

mianzg commented 3 months ago

I started a new branch called "cran" to continue working on it. I need the new branch so I can remove the code comments, but I want to keep those comments in the dev branch. They are mostly for feature improvement that I hope to implement in next version. I will merge and close this pull request.