bczernecki / climate

The R climate package: an interface for downloading in-situ meteorological (and hydrological) dataset
https://bczernecki.github.io/climate/
Other
77 stars 20 forks source link

Renaming #5

Closed Nowosad closed 4 years ago

Nowosad commented 5 years ago

Zbiory danych (i w efekcie ich odniesienie się w funkcjach) muszą być zaktualizowane. Np. meteo_stations teraz powinno nazywać się meteo_stations_imgw, etc:

Nowosad commented 5 years ago

A później ich nazwy w README/winietach.

aglogowski commented 5 years ago

Powinniśmy się trzymać też jednej konwencji w kolejności np. dla ogimetu mamy: ogimet_stations więc dla imgw powinno być imgw_meteo_stations

Czy może wogóle napier żeby było station a potem nazwa zbioru ?

Nowosad commented 5 years ago

Teraz mamy dwie konwencje: funkcje, które widzą użytkownicy meteo_ogimet i dane, które widzą użytkownicy ogimet_stations. Mi to odpowiada, ale możemy też to ujednolicić - jak uważasz, która opcja jest lepsza?

W kwestii Twojego przykładu to powinno być ogimet_meteo_stations i imgw_meteo_stations.

aglogowski commented 5 years ago

Funkcje takie jak :

odnoszą się do funkcji w paczce imgw zmiana tego wymusza zmiane w paczce imgw np. meteo_daily) co przestaje mieć sens bo w tej paczce są tylko dane imgw więc po co je indeksować tym dopiskiem. Dwie propozycje:

  1. usuwamy funkcje operacyjne takie jak meteo_metadata clean_metadata_hydro , meteo_abbrev itp. i zostawiamy tylko te funkcje nadrzędne, czyli w sumie będą to:
  1. Pozbywamy się odniesienia imgw i wrzucamy dosłownie wszystko do climate i zmieniamy wszystko jak leci.
aglogowski commented 5 years ago

Wydaje mi się, że ostatecznie tak to powinno wyglądać, krótko zwięźle i klarowanie. przykład

bczernecki commented 5 years ago

dobra, jak dla mnie to skoro imgw ma być tylko dodatkiem to funkcje ogimet_meteo i ogimet_stations powinny być bez przedrostka ogimet_. Tak samo wyoming_meteo_sounding jest bez sensu, bo jest tylko 1 funkcja do sondowań, więc zostawiłbym samo sounding.

Nowosad commented 5 years ago

@bczernecki Bartek, ja myślę odwrotnie. Dopiski z "ogimet" czy "wyoming" mają duży plus - pozwalają na mniej bolesne zmiany (e.g., dodanie innych źródeł danych) w przyszłości. Jak zrobisz tylko sounding teraz a za rok pojawi się jakaś inna strona z sounding, którą będziesz chciał dodać to będziesz miał dwie funkcje - stary sounding i nowy sounding_nowastrona. Ja bym sugerował, żeby od początku ten pakiet miał wbudowane miejsce na zmiany/dodatki.

Nowosad commented 5 years ago

@aglogowski funkcje do pobierania danych powinny zaczynać się od meteo_, hydro_, sounding_, a nie od dostawcy danych. Ludzi częściej interesuje co chcą pobrać, a nie od kogo - w ten sposób ławiej jest te funkcje znaleźć poprzez autocompletion niż zgadywać jak został opisany (i czy istnieje) dany dostawca danych.

aglogowski commented 5 years ago

@Nowosad oki zmiany w tekście można szybko poprawić a chciałem coś zrobić żeby dzisiaj było mniej nawet kosztem robienia czegoś dwa razy :D

aglogowski commented 5 years ago

Czy generalnie czy w tej burzliwej dyskusji ustaliliśmy i wszyscy się zgadzają, że ma być rodzaj (meteo, hydro, sounding)_ a potem nazwa repo (ogimet,wyoming,imgw) czy nie? bo wyczuwam tutaj dużą rozbieżność zdań.

bczernecki commented 5 years ago

Tak, zostajemy przy konwencji zaproponowanej przez @Nowosad , czyli meteo_, hydro_, sounding_wyoming

aglogowski commented 5 years ago

W takim razie, ja nie wiem jak to zrobić zeby było poprawnie od strony organizacyjnej więc prosze przyjżeć się funkcji meteo_stations i hydro_stations aby na końcu miały dopisek _imgw bo one są jakoś tak po profesorsku zaczytane i ja napewno coś zepsuje

Nowosad commented 5 years ago

Myślę, że nazwy obiektów powinny być teraz okej (ale oczywiście warto wszystko przejrzeć).