search

cynkra / sdtools

tools to work with swissdata sets
1 stars 0 forks source link

Minimal overview of the functions in the package in README.md #9

Closed christophsax closed 5 years ago

christophsax commented 5 years ago

This is nice:

Description: Provides tools for manipulation of swissdata objects
  The functionality includes the following types operations:
  1) printing objects and inspecting their validity,
  2) manipulating dimensions and dimension levels,
  3) combining two objects into one,
  4) reading and writing.

Could you extend that and put it at the end of README.md? So that a new user gets a quick overview of what can be done with the package and what functions are available. In addtion to DESCRIPTION, explicitly name them and say what they do (in one sentence or so).

A bit something like what I did here:

https://www.tsbox.help/reference/index.html

(I think I mentioned pkgdown somewhere but I don't find it. I think a few lines to README here are sufficient, so forget pkgdown)

karoliskoncevicius commented 5 years ago

Now in #12

karoliskoncevicius commented 5 years ago

Closing as #12 is merged now