Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/indenkun/starsign
Calculate the star sign and oriental zodiac.
https://github.com/indenkun/starsign
oriental-zodiac r starsign
Last synced: 24 days ago
JSON representation
Calculate the star sign and oriental zodiac.
- Host: GitHub
- URL: https://github.com/indenkun/starsign
- Owner: indenkun
- License: other
- Created: 2020-05-23T14:10:05.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-31T07:31:42.000Z (over 2 years ago)
- Last Synced: 2023-02-27T09:57:03.684Z (almost 2 years ago)
- Topics: oriental-zodiac, r, starsign
- Language: R
- Homepage:
- Size: 30.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- License: LICENSE
Awesome Lists containing this project
README
---
title: "README"
output: github_document
---
```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
devtools::load_all()
```
# `{staRsign}`
`{staRsign}`は誕生日などの日付から12星座を出力する`staRsign()`関数と、年（または年を含む日付データ）から十二支を出力する`oRiental_zodiac()`関数を含むパッケージです。
`{staRsign}` is a package containing the staRsign function to output 12 star signs from a date such as a birthday and the oRiental_zodiac function to output 12 oriental zodiac from a number of year (or date data containing a year).
現在、すべての関数は一つの値しか受け付けないようになっているので、複数の値を処理するときには必要に応じて`sapply()`関数等をつかってください。
Currently, all functions accept only one value, so if you need to process multiple values, use the `sapply()` function, etc. as necessary.
## How to install
```r
devtools::install_github("indenkun/staRsign")
```
## `staRsign()`
`staRsign()`は誕生日などの日付からから星占いで用いられている12星座をRで出力するための関数です。
`staRsign()` is a function to output the 12 star sign used in astrology from the date of birth on R.
### How to use
誕生日を入力すると12星座をラテン語式英名で出力します。
Enter the date of birth, it will output the 12 star sign in Latin English names.
```{r use1}
staRsign::staRsign("12/25")
```
標準では日付について"%m/%d"形式をサポートしますが、それ以外もフォーマットを指定すると処理可能です。
By default, "%m/%d" format is supported for the date, but other formats can be processed if the format is specified.
```{r use2}
staRsign::staRsign("2020/12/25", format = "%Y/%m/%d")
staRsign::staRsign("12-25", format = "%m-%d")
```
処理できない13/1やNAを含む日付以外のデータなどを入力するとNAを出力します。
If you input data that cannot be processed, such as 13/1 or data other than the date containing NA, NA will be output.
```{r use3}
staRsign::staRsign("13/1")
staRsign::staRsign(NA)
staRsign::staRsign("HOGE")
```
日本語（かな+座）での出力も可能です。
It is also possible to output in Japanese (かな + 座).
```{r use4}
staRsign::staRsign.ja("12/25")
```
## `oRintal_zodiac()`
`oRiental_zodiac()`は年または年を含む日付データから十二支をRで出力するための関数です。
`oRiental_zodiac()` is a function to output a zodiac on R from date data containing a year or number of year.
### How to use
引数に0以上の年を入力するとその年の十二支を英語で出力します。
Enter a number of year greater than or equal to 0 in the argument, the twelve signs of the oriental zodiac for that year will be output in English.
```{r use oriental1}
staRsign::oRiental_zodiac(2020)
```
デフォルトでは年のみか年を含む日付データをサポートします。
By default, it supports date data that contains only the year or the year.
日付データの場合はダブルコーテーションで必ず囲ってください。
For date data, be sure to enclose it with a double citation.
```{r use oriental2}
staRsign::oRiental_zodiac("2020/12/25")
```
ダブルコーテーションで囲わない場合は、計算式として解釈され、期待される十二支を返さないことがあります。
If not enclosed in double-cotations, it may be interpreted as a formula and may not return the expected twelve signs of the oriental zodiac.
```{r use oriental3}
# これは2000 / 2 / 1 = 1000として解釈されます
# This is interpreted as 2000 / 2 / 1 = 1000
staRsign::oRiental_zodiac(2000/2/1)
staRsign::oRiental_zodiac(2000)
staRsign::oRiental_zodiac("2000/2/1")
```
日付データはデフォルトで"%Y/%m/%d"形式をサポートしますが、それ以外の形式もformatで指定可能です。
The date data supports the "%Y/%m/%d" format by default, but other formats can also be specified in the format.
```{r use oriental4}
staRsign::oRiental_zodiac("2020/12", "%Y/%M")
```
日本語（漢字）での出力も可能です。
It is also possible to output in Japanese (Kanji).
```{r use oriental5}
staRsign::oRiental_zodiac.ja(2020)
staRsign::oRiental_zodiac.ja("2020/12/25")
```
## Imprors to use this package
- `{lubridate}`
## notice
`staRsign()`関数では誕生日のみを参照しています。
`staRsign()` function referring only to the date of birth.
西洋占星術で用いられる正確な十二宮（12星座）の時期については算出していません。
The exact timing of the Twelve Zodiac signs used in Western astrology has not been calculated.
現在、`oRiental_zodiac()`関数では負の年数を入れると正しい十二支を出力できません。
Currently, the `oRiental_zodiac()` function cannot output the correct oriental zodiac if a negative number of year is entered.
DESCRIPTIONに記載しているメールアドレスはダミーです。なにかあればISSUEに記載してください。
The email address listed in the DESCRIPTION is a dummy. If you have any questions, please post them on ISSUE.
冒頭に記載した通り、現在すべての関数は複数の値を受け付けないようになっています。`sapply()`関数等を使用し処理してください。
As noted at the beginning of this section, all functions currently do not accept multiple values. Use the `sapply()` function to handle multiple values.
```{r}
unname(sapply(c("1/1", "4/1", "9/1"), staRsign))
```
## License
MIT.