Comments (6)
I will give it a think. There should be a way to do it programmatically, as I would rather prefer not to have two manual updates that can get out of sync. Combining it with size makes perfect sense, as some - and the terrain you mentioned in #58 is the worst culprit - datasets are rather large. I have addressed it in the function docs, with a somewhat light hearted manner (size is ... , so proceed with caution and patience). But it may not be immediately obvious, since you had to ask.
Thank you for the point!
from rczechia.
Thanks for the comment, it is definitely a valid one - serving data is the chief purpose of the package.
The approach I took when writing it is that each function serves a {sf} flavored data frame, and the data source + cutoff date (more important for man made objects such as admin areas than say rivers or terrain) is in function documentation / the man pages.
Do you think it this would be a better practice to summarise it somewhere?
from rczechia.
I am using the @source field of the function documentation - e.g. https://github.com/jlacko/RCzechia/blob/master/man/volebni_okrsky.Rd#L7
from rczechia.
Ah - I see. It makes sense for it to be in the help pages, that is really useful. I think it would be worth mentioning it in the readme and/or in one of the examples - if it isn't already.
I think a summary would be useful too. You could do this pragmatically I think. A list of name, title, source would be ideal. You could also include size, but I see this is more work as it's not stored programmatically there I think. Happy for other reviewers to comment too.
from rczechia.
I have updated an existing summary of datasets in the package documentation to include source with link (where applicable) and download size. It is in intro section of the package manual, which is listed on CRAN in pdf format and distributed with the package as a set of markdown documents.
Unfortunately this document is not quite legible on GitHub directly, as the {tabular} field of a markdown file does not render in an user friendly manner in https://github.com/jlacko/RCzechia/blob/master/man/intro.Rd
On the other hand it felt more natural to expand an existing part of the package documentation rather than to create a entirely new file that would make sense only in GitHub context and would have to be ignored from build for CRAN distribution purposes due to standard checks.
from rczechia.
Thanks @jlacko - this makes sense, and looks good
from rczechia.
Related Issues (20)
- Don't pass NA to geocoding API HOT 3
- Reconsider return value of `geocode()` when no match HOT 7
- upcoming sf / s2 breaks RCzechia HOT 5
- digest in priniciple the Data50 / Data200 object HOT 2
- digest individual objects HOT 2
- low res rivers / smaller (no big deal) and more elegant (yeah!)
- Historical shapefiles HOT 4
- Pre-computed Vignette HOT 2
- encoding issue of NAZ_STAT in RCzechia::republika()
- Naming conflict in the rivers object / Lužnice × Lužnice
- update actions to current node.js
- Geomorphological divisions HOT 7
- License: JOSS Review HOT 1
- Data download times: JOSS Review HOT 3
- Community guidelines: JOSS Review HOT 4
- Install dev version: JOSS Review HOT 4
- test failure on terra::expanse() output change
- Add download links to readme HOT 4
- duplicites in 1930 census
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from rczechia.