changing structure

Author: lego-yaw

.github/workflows/CI.yml

@@ -78,6 +78,6 @@ jobs:
         shell: julia --project=docs --color=yes {0}
         run: |
           using Documenter: DocMeta, doctest
-          using ReadDBC
-          DocMeta.setdocmeta!(ReadDBC, :DocTestSetup, :(using ReadDBC); recursive=true)
-          doctest(ReadDBC)
+          using DBCDatasus
+          DocMeta.setdocmeta!(DBCDatasus, :DocTestSetup, :(using DBCDatasus); recursive=true)
+          doctest(DBCDatasus)

Project.toml

@@ -1,4 +1,4 @@
-name = "ReadDBC"
+name = "DBCDatasus"
 uuid = "79d50320-df92-4ae6-9b90-d461b5bc1756"
 authors = ["Bright-yaw <[email protected]> and contributors"]
 version = "1.0.0"

README.md

@@ -1,13 +1,13 @@
-# ReadDBC
+# DBCDatasus
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://lego-yaw.github.io/ReadDBC.jl/stable/)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://lego-yaw.github.io/ReadDBC.jl/dev/)
-[![Build Status](https://github.com/lego-yaw/ReadDBC.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/lego-yaw/ReadDBC.jl/actions/workflows/CI.yml?query=branch%3Amain)
-[![Coverage](https://codecov.io/gh/lego-yaw/ReadDBC.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/lego-yaw/ReadDBC.jl)
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://lego-yaw.github.io/DBCDatasus.jl/stable/)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://lego-yaw.github.io/DBCDatasus.jl/dev/)
+[![Build Status](https://github.com/lego-yaw/DBCDatasus.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/lego-yaw/DBCDatasus.jl/actions/workflows/CI.yml?query=branch%3Amain)
+[![Coverage](https://codecov.io/gh/lego-yaw/DBCDatasus.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/lego-yaw/DBCDatasus.jl)
 
 
 
-### ReadDBC.jl
+### DBCDatasus.jl
 + A simple package for converting *.dbc* (compressed DBC) files from Datasus into *.dbf* (DBF) and *data frames* tables. 
 
 + DATASUS plays a critical role in ensuring the efficient operation of Brazil's public health system. DATASUS is the name of the Departement of informatics of Brazil's health system (Sistema Unico de Saúde-SUS). They are responsible for maintaining and publishing Brazilian public health data. Aside this, the Brazilian National Agency for supplementary Health data (ANS), also use the same file format for storing public health data. 
@@ -19,29 +19,29 @@
 
 ```Julia-repl
 >>> ]
->>> add ReadDBC
+>>> add DBCDatasus
 ```
 or
 
 ```
 >>> using Pkg
->>> Pkg.add("ReadDBC")
+>>> Pkg.add("DBCDatasus")
 ```
 # Usage 
-+ ReadDBC is simple to use 
++ DBCDatasus is simple to use 
 
 ```
 # converting dbc to dbf format
->>> using ReadDBC
+>>> using DBCDatasus
 >>> dbctodbc("path/to/file.dbc, path/to/file.dbf) # input file is .dbc file and output file is .dbf
 
 # converting dbc into dataframe Table
->>> using ReadDBC
+>>> using DBCDatasus
 >>> df = dbcTable("path/to/file.dbc)" # input file is .dbc file and output file is in table format
 >>> head(df) 
 
 # Example
->>> using Download, using ReadDBC
+>>> using Download, using DBCDatasus
 >>> download("ftp://ftp.datasus.gov.br/dissemin/publicos/SIASUS/200801_/Dados/ABOAC1909.dbc", "ABOAC1909.dbc") # this link downlaods the ABOAC1909.dbc file from Datasus database.
 
 # run fucntion
@@ -50,7 +50,7 @@ or
 
 or
 
->>> using ReadDBC
+>>> using DBCDatasus
 >>> dbctodbc("ABOAC1909.dbc", "ABOAC1909.dbf") # conversion into DBF format
 
 ```

docs/make.jl

@@ -1,14 +1,14 @@
-using ReadDBC
+using DBCDatasus
 using Documenter
 
-DocMeta.setdocmeta!(ReadDBC, :DocTestSetup, :(using ReadDBC); recursive=true)
+DocMeta.setdocmeta!(DBCDatasus, :DocTestSetup, :(using DBCDatasus); recursive=true)
 
 makedocs(;
-    modules=[ReadDBC],
+    modules=[DBCDatasus],
     authors="Bright-yaw <[email protected]> and contributors",
-    sitename="ReadDBC.jl",
+    sitename="DBCDatasus.jl",
     format=Documenter.HTML(;
-        canonical="https://lego-yaw.github.io/ReadDBC.jl",
+        canonical="https://lego-yaw.github.io/DBCDatasus.jl",
         edit_link="main",
         assets=String[],
     ),
@@ -18,6 +18,6 @@ makedocs(;
 )
 
 deploydocs(;
-    repo="github.com/lego-yaw/ReadDBC.jl",
+    repo="github.com/lego-yaw/DBCDatasus.jl",
     devbranch="main",
 )

docs/src/index.md

@@ -1,14 +1,14 @@
 ```@meta
-CurrentModule = ReadDBC
+CurrentModule = DBCDatasus
 ```
 
-# ReadDBC
+# DBCDatasus
 
-Documentation for [ReadDBC](https://github.com/lego-yaw/ReadDBC.jl).
+Documentation for [DBCDatasus](https://github.com/lego-yaw/DBCDatasus.jl).
 
 ```@index
 ```
 
 ```@autodocs
-Modules = [ReadDBC]
+Modules = [DBCDatasus]
 ```

src/ABOAC1909.dbc mock_file.dbf

@@ -1,4 +1,4 @@
-module ReadDBC
+module DBCDatasus
 
 # Export functions 
 export dbcTable, dbctodbf
@@ -22,7 +22,7 @@ function dbctodbf(input_file::String, output_file::String)
     return output_file  # Optionally return the output file name
 end
 
-# Defining function readdbc
+# Defining function DBCDatasus
 function dbcTable(input_file::String)
     output_file = replace(input_file, ".dbc" => ".dbf")
     try
@@ -40,4 +40,4 @@ function dbcTable(input_file::String)
     end
 end
 
-end  # module readdbc
+end  # module DBCDatasus